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

manual pages: Remove unneeded SVN Date entry and selected cleanup #2143

Merged
merged 18 commits into from
Feb 3, 2022
Merged

manual pages: Remove unneeded SVN Date entry and selected cleanup #2143

merged 18 commits into from
Feb 3, 2022

Conversation

neteler
Copy link
Member

@neteler neteler commented Jan 30, 2022

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

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

- 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)
@neteler neteler added backport_needed manual Documentation related issues labels Jan 30, 2022
@neteler neteler added this to the 8.0.1 milestone Jan 30, 2022
@neteler neteler requested a review from ninsbl January 30, 2022 21:22
@neteler neteler self-assigned this Jan 30, 2022
Copy link
Member

@ninsbl ninsbl left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Wow, quite an extensive cleanup beyond "search and replace". It took me some time just to scroll through the changes to check nothing came in accidentally...
Looks good to me.

Copy link
Contributor

@veroandreo veroandreo left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for this effort to clean and homogenize manual pages :)
I mostly found extra spaces or missing spaces here and there

imagery/i.eb.hsebal01/i.eb.hsebal01.html Outdated Show resolved Hide resolved
db/drivers/mysql/grass-mesql.html Outdated Show resolved Hide resolved
raster/r.surf.random/r.surf.random.html Outdated Show resolved Hide resolved
raster3d/r3.in.ascii/r3.in.ascii.html Show resolved Hide resolved
scripts/r.fillnulls/r.fillnulls.html Outdated Show resolved Hide resolved
scripts/v.db.reconnect.all/v.db.reconnect.all.html Outdated Show resolved Hide resolved
temporal/t.create/t.create.html Outdated Show resolved Hide resolved
vector/v.out.ogr/v.out.ogr.html Outdated Show resolved Hide resolved
vector/v.what.rast3/v.what.rast3.html Show resolved Hide resolved
vector/v.what.rast/v.what.rast.html Show resolved Hide resolved
neteler and others added 5 commits January 31, 2022 18:33
Co-authored-by: Veronica Andreo <veroandreo@gmail.com>
Co-authored-by: Veronica Andreo <veroandreo@gmail.com>
Copy link
Member

@tmszi tmszi left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good to me.

@wenzeslaus wenzeslaus removed their request for review February 2, 2022 18:29
@neteler
Copy link
Member Author

neteler commented Feb 2, 2022

Looks good to me.

Thanks for your huge support in beautifying the HTML pages, @tmszi!

All done now from my side, including the double empty line removal (5c09ae0).

neteler added a commit to OSGeo/grass-addons that referenced this pull request 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>
@@ -1,4 +1,5 @@
<h2>DESCRIPTION</h2>

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Seems it added an extra empty line here.

Copy link
Member

@tmszi tmszi left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

There seems to be one empty line left somewhere and it has been added somewhere. Could you reapply that filter in the Geany editor (bulk modification) please, or we leave it like this, or we can try sed stream editor?

@neteler
Copy link
Member Author

neteler commented Feb 3, 2022

There seems to be one empty line left somewhere and it has been added somewhere.

I have fixed those indicated by you.

Could you reapply that filter in the Geany editor (bulk modification) please,

This "filter" does not exist - I manually created search/replace operations in the Geany editor.

or we leave it like this, or we can try sed stream editor?

Please let's stop here, I would suggest to rather invest energy in adding missing examples rather than hunting more empty lines which are harmless.

@tmszi
Copy link
Member

tmszi commented Feb 3, 2022

Please let's stop here, I would suggest to rather invest energy in adding missing examples rather than hunting more empty lines which are harmless.

I agree with you!

@neteler neteler merged commit 547ff44 into OSGeo:main Feb 3, 2022
@neteler neteler deleted the manual_pages_remove_svn_date branch February 3, 2022 10:10
neteler added a commit that referenced this pull request 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 pull request 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>
@wenzeslaus wenzeslaus changed the title manual pages: remove unneeded SVN Date entry and selected cleanup manual pages: Remove unneeded SVN Date entry and selected cleanup Apr 27, 2022
ninsbl pushed a commit to ninsbl/grass that referenced this pull request 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 pull request 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 pull request 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
manual Documentation related issues
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

5 participants