Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

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

Merged
merged 1 commit into from
Feb 28, 2024

Conversation

ItIsJordan
Copy link
Collaborator

@ItIsJordan ItIsJordan commented Feb 28, 2024

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/

Updates the bidirectional linking documentation for records/tables to note that the intended use for the field is not for self-referencing.
Copy link

codecov bot commented Feb 28, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

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

Additional details and impacted files
@@           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 Coverage Δ
unittests-3.10 87.99% <ø> (ø)
unittests-3.6 87.68% <ø> (ø)
unittests-3.7 87.68% <ø> (ø)
unittests-3.8 87.81% <ø> (ø)
unittests-3.9 87.81% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

Copy link
Collaborator

@clelange clelange left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks!

@clelange clelange merged commit eb392fe into main Feb 28, 2024
16 checks passed
@clelange clelange deleted the self-reference-doc-update branch February 28, 2024 17:03
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants