Remove outdated comments from XSD file#84
Open
mbtaylor wants to merge 1 commit intoivoa-std:masterfrom
Open
Conversation
The VOTable.xsd file contained several parts that looked like XML content but were actually commented out, mostly being suggestions for future or relics of the past. This was especially confusing since the full XSD appears in an Appendix of the VOTable document without syntax highlighting, so you could easily look at something and think it's part of the VOTable schema when it's actually part of an XML comment. This commit removes such commented-out XML, as well as associated commentary text and some comments (mostly XML comments, but also one xs:documentation element) that constitute musings of the authors of essentially historical interest only.
Member
Author
|
I have been fairly conservative here - there is a bit more cruft that could be pulled out. The remaining comments are a bit ad hoc and I have not attempted to homogenise them. In particular the update summary right at the start is not usual for IVOA XSD documents, and provides a fairly patchy picture of the history of the document, which VO archaeologists could presumably examine better using the version control system. So it might be a good idea to remove that as well, but it's fairly harmless and doesn't obscure the rest of the content. So more action in this area is up for discussion. |
msdemlei
approved these changes
Mar 10, 2026
Collaborator
msdemlei
left a comment
There was a problem hiding this comment.
That's a clear improvement. Thanks!
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
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.
The VOTable.xsd file contained several parts that looked like XML content but were actually commented out, mostly being suggestions for future or relics of the past.
This was especially confusing since the full XSD appears in an Appendix of the VOTable document without syntax highlighting, so you could easily look at something and think it's part of the VOTable schema when it's actually part of an XML comment.
This commit removes such commented-out XML, as well as associated commentary text and some comments (mostly XML comments, but also one xs:documentation element) that constitute musings of the authors of essentially historical interest only.