Docs: Fix XML code blocks

[nxtn]

Some hand-written XML code blocks contain mistakes. I tried to find them out with XmlReader.

The output is here with a few false positives.

[Thraka]

Thank you for tackling this. I'm assigning this to you and I'll put it in our current project/milestone. Please let me know when you've finished (it seems like you're going to do multiple PRs?) and I'll close this.

[nxtn]

You could remove the WIP label and add an up-for-grabs.

[mairaw]

Done @NextTurn

[nxtn]

280 left.

[Youssef1313]

280 left.

@NextTurn, the link in the original issue is dead. May you update the issue with those 280 ?

[nxtn]

I'd be glad if you would pick it up. @Youssef1313.

274

https://gist.github.com/NextTurn/a1445dfee1b8e51d5890c9b886a3fbf1

[cloudn9]

Hello @Youssef1313 , how could I help with this issue ? Is this (https://gist.github.com/NextTurn/a1445dfee1b8e51d5890c9b886a3fbf1)
the last version of what has been left ?
Thank you.

[nxtn]

@cloudn9 Sorry for the delay. I've updated the gist with 267 entries.

[nxtn]

@Thraka I should have raised this question eons ago: shall we consider using {} for placeholders in place of <>? Braces are used in XML docs (triple-slash comments) and often used in file names for generic type signatures (e.g. List{T}).

[cloudn9]

@Thraka I should have raised this question eons ago: shall we consider using {} for placeholders in place of <>? Braces are used in XML docs (triple-slash comments) and often used in file names for generic type signatures (e.g. List{T}).

Thank you @NextTurn for that quesiton. I had some doubts while removing the <>s.

[Thraka]

I think having no special syntax is fine. The placeholders are usually in some sort of context that is talking about that specific feature or area of XML so it's easy to understand. I would just make sure that the placeholder uses - to connect words like package-id or version-number.

[cloudn9]

I think having no special syntax is fine. The placeholders are usually in some sort of context that is talking about that specific feature or area of XML so it's easy to understand. I would just make sure that the placeholder uses - to connect words like package-id or version-number.

Thank you @Thraka, so if in our case we have "previous value" it becomes "previous-value" right ?
It does not mean that the previous value should contain a - inside ?

[Thraka]

Correct.