Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: v.buffer.html minor edits #4744

Merged
merged 1 commit into from
Nov 25, 2024
Merged

docs: v.buffer.html minor edits #4744

merged 1 commit into from
Nov 25, 2024

Conversation

dhdeangelis
Copy link
Contributor

Something to consider: is the following commented part still relevant? If not it could perhaps be deleted, if yes it could perhaps be made a visible part of the manual. There is another reference to the GRASS buffer, so perhaps it is still worth keeping it as a note or comment near the end?

<!-- Only support by GRASS buffer
Flag <b>-s</b> also influences corners around polygons (see red color
on the figure below):

<center>
  <img src="v_buffer_area.png">
  <img src="v_buffer_area_s.png">
</center>
-->

@github-actions github-actions bot added vector Related to vector data processing HTML Related code is in HTML module docs labels Nov 23, 2024
@echoix
Copy link
Member

echoix commented Nov 23, 2024

I'm not sure myself either, as it isn't exactly clear. The images are still there though.
What I understand is that this module uses GEOS unless it is not available, and the commented docs only apply in this case. Having beautiful illustrations appear when skimming through, but that don't apply most of the time might be misleading.

That doc was changed 9 years ago in cfd4808#diff-ac9836873e08c679bbe410bce6413b8facf60c84f0e08c83e30a8e5cc0019ccbR24-R57 from @landam and seems the images were added there.

@dhdeangelis
Copy link
Contributor Author

Who uses GRASS without GEOS these days? Perhaps the commented paragraph and the images it references could be deleted.

But if this use case is still considered relevant, then the commented part, together with the "For advanced users ..." paragraph, could be put together at the end as a section apart.

@dhdeangelis
Copy link
Contributor Author

@echoix perhaps we can leave this little question for the future, merge and close?

@echoix
Copy link
Member

echoix commented Nov 25, 2024

I'm also fine with this, I hoped someone would've jumped in. For docs, I really believe that PRs that improve even just a bit should be merged really quickly, as long as it doesn't regress, they should always be welcomed and merged in a timely matter.

@echoix echoix merged commit 036451f into OSGeo:main Nov 25, 2024
23 checks passed
@github-actions github-actions bot added this to the 8.5.0 milestone Nov 25, 2024
@dhdeangelis dhdeangelis deleted the manfx4 branch November 25, 2024 12:07
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs HTML Related code is in HTML module vector Related to vector data processing
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants