nvda
eee34636 - Fix the structure of sublists in `changes.md` (#17741)

Commit
1 year ago
Fix the structure of sublists in `changes.md` (#17741) Fixes #16662 Summary of the issue: When the documentation was written in .t2t format, the format for sub-lists was more tolerant regarding the size of the indentation of the sub-list. Most sub-lists were indented 2 spaces, but some of them were only indented 1 space. Now that we have transitioned to .md format, this atypical indentation causes them not to be recognized as a sub-list when converted to HTML. Description of user facing changes * The sub-lists in the HTML change log should now appear as before the t2t to md transition. * Translators should not be impacted by this change. I.e. modified content belong to an already translated change log and translators should not have to re-translate old parts of the change log. Description of development approach * Searched for lines beginning with an even number of space (regexp: "`(?<=\n) ( )*(?=[^ ])`") and manually fixed each found line as well as the subsequent ones, i.e. other sub-list items and sub-sub-list items * Did not modify lines beginning with space but no list bullet, because it would have an impact on translators work; moreover these ones do not seem to cause HTML formatting issues. One line beginning with " - " remains unfixed. I cannot modify it without impacting translators' work. Testing strategy: * Used the xliff generation script to check that no translator's change will happen. See https://github.com/nvaccess/nvda/pull/17741#issuecomment-2747459979 for details. Known issues with pull request: * If some translators have a translated change log in SVN that has not yet been migrated to Crowdin, it will probably not be possible anymore to migrate SVN content, i.e. the change log will have to be re-translated from scratch. Though, I guess that all translators that would have needed to pre-translate their translation should already have migrated. * If #17735 is implemented, this PR may be more difficult to merge; thus, it would be better to merge it before implementing #17735.
Author
Parents
Loading