manual: fix more broken HTML tags#4765
Merged
neteler merged 2 commits intoOSGeo:mainfrom Nov 27, 2024
neteler:manual_HTML_tag_fixes
Merged
manual: fix more broken HTML tags#4765neteler merged 2 commits intoOSGeo:mainfrom neteler:manual_HTML_tag_fixes
neteler merged 2 commits intoOSGeo:mainfrom
neteler:manual_HTML_tag_fixes
Conversation
In order to obtain a good result when converting the HTML manual pages files to markdown, ideally clean HTML code is used. This PR fixes numerous broken HTML tags identified during a test run of [adding HTML validation with super-linter](echoix#303). For reference, see logs showing the errors at https://github.com/echoix/grass/actions/runs/12001379426/job/33451802353?pr=303#step:4:8310 Fixes: - incomplete tag pairs - tabs replaced with white space
neteler
added
manual
echoix
previously approved these changes
Nov 26, 2024
Member
echoix
left a comment
echoix
left a comment
There was a problem hiding this comment.
I've left one comment. And also saw that an url to grassbook was changed to neteler
Member
|
For the tabs vs spaces, line endings, end of line, etc, there's an editorconfig file that can be useful, and enforced with editorconfig-checker. Editorconfig-checker can be enabled in super-linter too. I've started the work of preparing the repo for it months ago, that's where the 2 still unmerged PRs changing shell scripts came from (very inconsistent tabs vs spaces). I think Python is ready now (or almost). Anyways, it's only another tool up the sleeve for this kind of checks. |
Member
Author
Additionally, it would be good to also update: |
echoix
approved these changes
Nov 27, 2024
Member
|
Let's go with it! |
echoix
added a commit
that referenced
this pull request
Nov 28, 2024
* manual: fix more broken HTML tags In order to obtain a good result when converting the HTML manual pages files to markdown, ideally clean HTML code is used (continuation of #4765). This PR fixes numerous broken HTML tags identified during a test run of [adding HTML validation with super-linter](echoix#303). For reference, see logs showing the errors at https://github.com/echoix/grass/actions/runs/12067630007/job/33651008404?pr=303 Fixes include: - complete selected ncomplete tag pairs (esp. `<li>`) - tabs replaced with white space - `<`, `>`, `&` replaced with their HTML representations * Apply suggestions from code review --------- Co-authored-by: Edouard Choinière <[email protected]>
neteler
added a commit
that referenced
this pull request
Nov 30, 2024
Backport of #4765 In order to obtain a good result when converting the HTML manual pages files to markdown, ideally clean HTML code is used. This PR fixes numerous broken HTML tags identified during a test run of [adding HTML validation with super-linter](echoix#303). For reference, see logs showing the errors at https://github.com/echoix/grass/actions/runs/12001379426/job/33451802353?pr=303#step:4:8310 Fixes: - incomplete tag pairs - tabs replaced with white space - fix missing .html extension in URLs
neteler
added a commit
that referenced
this pull request
Nov 30, 2024
* manual: fix more broken HTML tags In order to obtain a good result when converting the HTML manual pages files to markdown, ideally clean HTML code is used (continuation of #4765). This PR fixes numerous broken HTML tags identified during a test run of [adding HTML validation with super-linter](echoix#303). For reference, see logs showing the errors at https://github.com/echoix/grass/actions/runs/12067630007/job/33651008404?pr=303 Fixes include: - complete selected ncomplete tag pairs (esp. `<li>`) - tabs replaced with white space - `<`, `>`, `&` replaced with their HTML representations * Apply suggestions from code review --------- Co-authored-by: Edouard Choinière <[email protected]>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
In order to obtain a good result when converting the HTML manual pages files to markdown, ideally clean HTML code is used.
This PR fixes numerous broken HTML tags identified during a test run of adding HTML validation with super-linter.
For reference, see logs showing the errors at
https://github.com/echoix/grass/actions/runs/12001379426/job/33451802353?pr=303#step:4:8310
Fixes (there is not much variety here, just many occurrences):
<li>)<,>,&replaced with their HTML representations<br>within<em> ... </em>since this will not be properly converted bypandocTesting: the simplest approach is to see if the code still compiles. Locally it does.