add some basic documentation #54
Conversation
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #54 +/- ##
==========================================
- Coverage 77.86% 77.71% -0.15%
==========================================
Files 16 15 -1
Lines 768 763 -5
==========================================
- Hits 598 593 -5
Misses 170 170 ☔ View full report in Codecov by Sentry. |
| Metadata specification | ||
| ---------------------- | ||
|
|
||
| The detector geometry is constructed based on the LEGEND metadata specification `(metadata-docs) <https://github.com/legend-exp/legend-detectors/tree/main/germanium/diodes>`_. |
There was a problem hiding this comment.
maybe also link to the public testdata. Also mention that this link is private?
Co-authored-by: Manuel Huber <[email protected]>
Co-authored-by: Manuel Huber <[email protected]>
|
|
||
| legendhpges can be installed with pip. | ||
|
|
||
| .. code-block:: console |
There was a problem hiding this comment.
Shouldn't we advise users to directly install from PyPI, or to do an editable install (pip install **-e**)? With the current instructions, they have a code folder that they cannot edit, but might expect to be able to do so...
There was a problem hiding this comment.
i guess that information can be added to some section on "developer instructions" or something?
No description provided.