Can't always follow "Edit on GitHub"

[jidanni]

What is the bug?

1. visit https://gdal.org/api/gdal_alg.html
2. Observe many grammar etc. errors, e.g.,

• ensure all values are contained i the range -1 to +1.

3. Push the "Edit on GitHub" button.

Alas, normal users are now thrown off track and will give up pursing the matter. (Yes, maybe #10000, but that's beside the point.)

[jratike80]

Do you mean that the screen that the button opens leads into -> "normal users are now thrown off track and will give up pursing the matter"? And that they give up without pressing the green button or withour learning more?

[rouault]

The content of the gdal_alg.html pages and other similar API pages is dynamically generated from Doxygen documentation of C/C++ functions. Not everything is convenient in life :-) That's the point where you need to look in GDAL source code and fix the issues at the source.

[dbaston]

Would it be helpful if I put a comment at the top of the .rst files along the lines of "the text rendered on this page is automatically generated from Doxygen comments in .cpp source files" or "the text rendered on this page is automatically generated from Python docstrings".

[rouault]

Would it be helpful if I put a comment at the top of the .rst files along the lines of "the text rendered on this page is automatically generated from Doxygen comments in .cpp source files" or "the text rendered on this page is automatically generated from Python docstrings".

Sounds good to me