On Fri, May 26, 2017 at 6:57 AM, tokidev <[email protected]> wrote: > Hi, folks! > > On your website, there at least two Markdown conventions in contentual > conflict. > > At [1] in the section "Markdown Conventions", the second point says: > >> * Hard wrap Markdown lines at 80 characters. > > At [2] in the section "Markdown Conventions", the second point says: > >> * Insert a newline at the end of each sentence. >> >> * Rationale: This practice is most appropriate for source that >> consists primarily of natural language text. It results in >> the most useful diffs and facilitates translation into other >> languages while mostly preserving source readability. > > As long as there are no special reasons for these contradictory rules, I > suggest to resolve that conflict, e.g. by deleting one of those > convention lists and link to the other instead. > > I prefer the latter convention point to keep (since most links point to > these [2] conventions and because of the given rationale -especially the > translation thing). > > > Why is this important? Well, there are lots of Markdown files with more > than one sentence per line or with partial sentences per line. Both > result in very ugly phrases to translate at Transifex. :S To be honest, > I lose my desire to translate such things. I guess that other > translators think alike. > > > Kind regards, > Tobias > > [1] https://github.com/QubesOS/qubesos.github.io/blob/master/README.md > [2] > https://github.com/QubesOS/qubes-doc/blob/master/basics_user/doc-guidelines.md
The 2nd convention is the correct way forward. 1st one should be removed (but still applies to source code). I have a WIP script to convert all our existing Markdown to the 2nd convention, but ensuring there are no edge cases is nontrivial. Is your progress is blocking on a complete conversion? If so I'm happy to move it up on my to-do list. Regards, Jean-Philippe -- You received this message because you are subscribed to the Google Groups "qubes-devel" group. To unsubscribe from this group and stop receiving emails from it, send an email to [email protected]. To post to this group, send email to [email protected]. To view this discussion on the web visit https://groups.google.com/d/msgid/qubes-devel/CABQWM_BSZQLQxJ1A6i1fVebqWsVgNJLe8Rjg%2Ba7PX9_i9ROzUQ%40mail.gmail.com. For more options, visit https://groups.google.com/d/optout.
