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

XML comments within elementSpecs should never be rendered #692

Open
lb42 opened this issue Jul 22, 2024 · 0 comments
Open

XML comments within elementSpecs should never be rendered #692

lb42 opened this issue Jul 22, 2024 · 0 comments

Comments

@lb42
Copy link
Member

lb42 commented Jul 22, 2024

Take a look at for example msDesc.xml : this has some editorial comments both within the <content> element, and the <constraintSpec> element. The latter appear in both HTML and PDF versions; the former do not. This is at best inconsistent! But in any case XML comments within the source of P5 should never be rendered in published versions. If it's important, put it in the <remarks> ; if it's just for virtue signalling , please don't clutter up the source with your working.
p.s. XML comments within <egXML.> however are often useful and should be rendered (as they are in this case, if you switch to the French version)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant