Skip to content

Commit

Permalink
Changing documentation for 1.0.0 release (#28)
Browse files Browse the repository at this point in the history
* Changing documentation for 1.0.0 release

* Removing missed FIXIT section
  • Loading branch information
esimpsons3ti authored Jul 9, 2024
1 parent aa8bafa commit d856e02
Showing 1 changed file with 0 additions and 15 deletions.
15 changes: 0 additions & 15 deletions docs/pds4_create_xml_index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -18,10 +18,6 @@ and accessing structured data within PDS4-compliant datasets.
XPath Syntax and Structure
--------------------------

(FIXIT The next two paragraphs need to be rewritten becase the user *doesn't* need to
learn ``lxml``, just the XPath format we provide. We should explain that in detail, with
examples.)

Before using the tool, it is imperative that the user becomes comfortable with
the XPath language and how it is parsed with ``lxml``.

Expand Down Expand Up @@ -190,14 +186,3 @@ Miscellaneous

- ``--config-file``: Specify a ``.ini``-style configuration file for further customization
of the extraction process.



(FIXIT) ADDITIONAL THINGS TO DISCUSS
------------------------------------

- Explanation of how we format XPaths (e.g. what do the ``<1>``-style suffixes mean?)
- Format and contents of the ``--config-file`` config file including discussion of
nillable elements.
- Format and contents of the ``--label-user-file`` config file (and should these be the
same thing?)

0 comments on commit d856e02

Please sign in to comment.