search

HEPData / hepdata_lib

Library for getting your data into HEPData
https://hepdata-lib.readthedocs.io
MIT License
15 stars 37 forks source link

Update usage.rst to include self-referencing notice #258

Closed ItIsJordan closed 5 months ago

ItIsJordan commented 5 months ago

Updates the bidirectional linking documentation for records/tables to note that the intended use for the field is not for self-referencing as mentioned in HEPData/hepdata Issue 765

📚 Documentation preview 📚: https://hepdata-lib--258.org.readthedocs.build/en/258/

codecov[bot] commented 5 months ago

Codecov Report

All modified and coverable lines are covered by tests :white_check_mark:

Project coverage is 87.99%. Comparing base (ab8bbef) to head (7039515).

Additional details and impacted files ```diff @@ Coverage Diff @@ ## main #258 +/- ## ======================================= Coverage 87.99% 87.99% ======================================= Files 5 5 Lines 1083 1083 Branches 231 231 ======================================= Hits 953 953 Misses 91 91 Partials 39 39 ``` | [Flag](https://app.codecov.io/gh/HEPData/hepdata_lib/pull/258/flags?src=pr&el=flags&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=HEPData) | Coverage Δ | | |---|---|---| | [unittests-3.10](https://app.codecov.io/gh/HEPData/hepdata_lib/pull/258/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=HEPData) | `87.99% <ø> (ø)` | | | [unittests-3.6](https://app.codecov.io/gh/HEPData/hepdata_lib/pull/258/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=HEPData) | `87.68% <ø> (ø)` | | | [unittests-3.7](https://app.codecov.io/gh/HEPData/hepdata_lib/pull/258/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=HEPData) | `87.68% <ø> (ø)` | | | [unittests-3.8](https://app.codecov.io/gh/HEPData/hepdata_lib/pull/258/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=HEPData) | `87.81% <ø> (ø)` | | | [unittests-3.9](https://app.codecov.io/gh/HEPData/hepdata_lib/pull/258/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=HEPData) | `87.81% <ø> (ø)` | | Flags with carried forward coverage won't be shown. [Click here](https://docs.codecov.io/docs/carryforward-flags?utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=HEPData#carryforward-flags-in-the-pull-request-comment) to find out more.

:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Have feedback on the report? Share it here.