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

[Question] Keeping Last changed commented in manual pages #684

Closed
echoix opened this issue Jan 22, 2022 · 4 comments · Fixed by #692
Closed

[Question] Keeping Last changed commented in manual pages #684

echoix opened this issue Jan 22, 2022 · 4 comments · Fixed by #692

Comments

@echoix
Copy link
Member

echoix commented Jan 22, 2022

Since PRs OSGeo/grass#2100, OSGeo/grass#2110, OSGeo/grass#2111, OSGeo/grass#2113,OSGeo/grass#2110 added automatic inclusion of dates in the manual pages, I'm asking if newer (addons) manual pages should keep the old <p> <i>Last changed: $Date$</i> commented out or remove the HTML comment when updating the pages.

If they are to remove, is it better to remove all of them in one commit (all of them will have the same date), or incrementally when changing files?

I'm still following up on the spelling fixes long-term chore.
Sorry if I chose an issue here to ask even if it's not a bug, I didn't find a better place for this.

@echoix
Copy link
Member Author

echoix commented Jan 29, 2022

Perhaps I could use some guidelines, like from @neteler? Is someone else qualified to suggest?

@neteler
Copy link
Member

neteler commented Jan 29, 2022

For me no longer a need to keep the commented entries.

@ninsbl do you need them or shall we remove them everywhere in core and addons?

If to be removed, then I suggest an all-in-one single commit.

@echoix
Copy link
Member Author

echoix commented Jan 29, 2022

Ok, that's good for me! If @ninsbl has the same opinion, we can close this and add this to a better todo list, since it won't be a question anymore, but rather a task to do.

@ninsbl
Copy link
Member

ninsbl commented Jan 29, 2022

I dont think they are needed any more. g.citation would need some adjustment, but I am on that in #677. So, please go ahead and remove

neteler added a commit that referenced this issue Feb 2, 2022
* Addon manual pages: remove unneeded SVN Date entry

- remove already commented and unneeded SVN Date entries from all manual relate pages
- selectively update section order to follow https://trac.osgeo.org/grass/wiki/Submitting/Docs#HTMLPages

Note: This change brings in the disadvantage that *all* manual pages are touched in terms of editing date, which influences the recent PR OSGeo/grass#2100 and the `g.citation` efforts ongoing in #677. On the other hand, it needs to be done one day...

See
- discussion in #684 (comment)
- in GRASS-core, see OSGeo/grass#2143

Co-authored-by: Veronica Andreo <veroandreo@gmail.com>
neteler added a commit to OSGeo/grass that referenced this issue Feb 3, 2022
)

- remove already commented and unneeded SVN Date entries from all manual relate pages
- selectively update section order to follow https://trac.osgeo.org/grass/wiki/Submitting/Docs#HTMLPages

See discussion in OSGeo/grass-addons#684 (comment)

Co-authored-by: Veronica Andreo <veroandreo@gmail.com>
Co-authored-by: Tomas Zigo <50632337+tmszi@users.noreply.github.com>
neteler added a commit to OSGeo/grass that referenced this issue Feb 3, 2022
)

- remove already commented and unneeded SVN Date entries from all manual relate pages
- selectively update section order to follow https://trac.osgeo.org/grass/wiki/Submitting/Docs#HTMLPages

See discussion in OSGeo/grass-addons#684 (comment)

Co-authored-by: Veronica Andreo <veroandreo@gmail.com>
Co-authored-by: Tomas Zigo <50632337+tmszi@users.noreply.github.com>
IvanMarchesini pushed a commit to IvanMarchesini/grass-addons that referenced this issue Feb 24, 2022
* Addon manual pages: remove unneeded SVN Date entry

- remove already commented and unneeded SVN Date entries from all manual relate pages
- selectively update section order to follow https://trac.osgeo.org/grass/wiki/Submitting/Docs#HTMLPages

Note: This change brings in the disadvantage that *all* manual pages are touched in terms of editing date, which influences the recent PR OSGeo/grass#2100 and the `g.citation` efforts ongoing in OSGeo#677. On the other hand, it needs to be done one day...

See
- discussion in OSGeo#684 (comment)
- in GRASS-core, see OSGeo/grass#2143

Co-authored-by: Veronica Andreo <veroandreo@gmail.com>
ninsbl pushed a commit to ninsbl/grass that referenced this issue Oct 26, 2022
…Geo#2143)

- remove already commented and unneeded SVN Date entries from all manual relate pages
- selectively update section order to follow https://trac.osgeo.org/grass/wiki/Submitting/Docs#HTMLPages

See discussion in OSGeo/grass-addons#684 (comment)

Co-authored-by: Veronica Andreo <veroandreo@gmail.com>
Co-authored-by: Tomas Zigo <50632337+tmszi@users.noreply.github.com>
ninsbl pushed a commit to ninsbl/grass that referenced this issue Feb 17, 2023
…Geo#2143)

- remove already commented and unneeded SVN Date entries from all manual relate pages
- selectively update section order to follow https://trac.osgeo.org/grass/wiki/Submitting/Docs#HTMLPages

See discussion in OSGeo/grass-addons#684 (comment)

Co-authored-by: Veronica Andreo <veroandreo@gmail.com>
Co-authored-by: Tomas Zigo <50632337+tmszi@users.noreply.github.com>
neteler added a commit to nilason/grass that referenced this issue Nov 7, 2023
…Geo#2143)

- remove already commented and unneeded SVN Date entries from all manual relate pages
- selectively update section order to follow https://trac.osgeo.org/grass/wiki/Submitting/Docs#HTMLPages

See discussion in OSGeo/grass-addons#684 (comment)

Co-authored-by: Veronica Andreo <veroandreo@gmail.com>
Co-authored-by: Tomas Zigo <50632337+tmszi@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants