Documentation fixes and schema cleanup #272
Merged
Conversation
This file contains 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
This would allow downstream packages to not only use the schema checker, but also the documentation generation. It's not a particularly large module, so no big harm?
This removes e.g. antenna_name from UVW in VisibilityXds, as this is a dimensionality that would not be allowed in that context. We especially complain when a data array has impossible dimensionality, which automatically catches some inconsistencies in the correlated data schemas.
Also add "data" to the data array one - you can literally get the data by accessing that member of the DataArray, so it is likely appropriate.
We are trying to format rather big tables, so all the margins add up rather quickly.
They just look confusing in the documentation
scpmw
changed the title
Turned out to be a bigger refactoring than I had anticipated - but we should generally try to not use nested parses too much here, and instead directly generate the document AST. This also changes the layout slightly - we generate "a,b,c or d" lists, and use non-breaking spaces to make sure the "or d" bit stays together.
scpmw
force-pushed
the
documentation-fixes-and-schema-cleanup
branch
from
5ec2625 to
9197852
Compare
4 tasks
FedeMPouzols
reviewed
Oct 4, 2024
| @@ -1892,7 +1904,7 @@ class SpectrumXds: | |||
| """ | |||
|
|
|||
| # --- Optional Coordinates --- | |||
| polarization_mixed: Optional[Coord[tuple[BaselineId, Polarization], str]] = None | |||
| polarization_mixed: Optional[Coord[tuple[AntennaName, Polarization], str]] = None | |||
FedeMPouzols
reviewed
Oct 4, 2024
|
|
||
| # Assume it's a literal of some kind - collect options | ||
| literals = format_literals(attr.typ) | ||
| print(literals) |
There was a problem hiding this comment.
I think this print is a leftover?
FedeMPouzols
reviewed
Oct 4, 2024
| else: | ||
| line += nodes.Text(", ") | ||
| line += lit | ||
| print(line) |
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.
Fix a couple nice-to-haves in the schema documentation: