Mivot writer #627
Mivot writer #627
Conversation
Codecov ReportAttention: Patch coverage is
Additional details and impacted files@@ Coverage Diff @@
## main #627 +/- ##
==========================================
+ Coverage 82.31% 82.77% +0.46%
==========================================
Files 72 75 +3
Lines 7429 7607 +178
==========================================
+ Hits 6115 6297 +182
+ Misses 1314 1310 -4 ☔ View full report in Codecov by Sentry. |
Forced pull after having squashed tiny commits dues to CI errors
docs/mivot/index.rst
Outdated
| ********************* | ||
| MIVOT (``pyvo.mivo``) | ||
| ********************* |
There was a problem hiding this comment.
typo
| ********************* | |
| MIVOT (``pyvo.mivo``) | |
| ********************* | |
| ********************** | |
| MIVOT (``pyvo.mivot``) | |
| ********************** |
pyvo/mivot/writer/annotations.py
Outdated
| blocks into VOTable files. The MIVOT block, represented as an XML structure, is used for | ||
| data model annotations in the IVOA ecosystem. | ||
|
|
||
| Features: |
There was a problem hiding this comment.
While I see the motivation for including some narrative docs with the source code, this section is not at all included in the rendered documentation as is not being part of any testing. So any information listed here likely need to be repeated and then kept in sync with the narrative docs. So my suggestion would be to remove the details from here and only have the narrative docs, as well as docstrings in any user facing functionality.
MIVOT items put together.
default pyvo.mivot content code stye add license
optional with mandatory keyword
|
The 3.11 step failed on a Simbad TAP server error |
|
The simbad failure is unrelated and I see it in This is ready for review for @astropy/pyvo-maintainers |
API for creating and writing MIVOTY annotation
#. Create individual instances (INSTANCE) using the
MivotInstanceclass#. Wrap the annotations with the
MivotAnnotationsclass#. Insert the annotations into a VOtable by using the Astropy API (wrapped in the package logic).
The annotation builder does not check whether the XML conforms to any particular model.
It simply validates it against the MIVOT XML Schema if the
xmlvalidatorpackage if is installed.The documentation has been split in 2 separate sections (reading and writing MIVOT)