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.

Sign up for GitHub

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
Merged

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

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions docs/usage.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -155,6 +155,8 @@ To add a link to a related record object, you can use the ``add_related_recid``

In the last example, we are adding a link to the submission with the record ID value of ``3``.

**Please note:** This field should not be used for self-referencing, the IDs inserted should be for OTHER related records.

The documentation for this feature can be found here: `Linking records`_.

.. _`Linking records`: https://hepdata-submission.readthedocs.io/en/latest/bidirectional.html#linking-records
Expand Down Expand Up @@ -312,6 +314,8 @@ To add a link to a related table object, you can use the ``add_related_doi`` fun

In the second example, we are adding a link to the table with a DOI value of `10.17182/hepdata.12882.v1/t2 <https://doi.org/10.17182/hepdata.12882.v1/t2>`_.

**Please note:** This field should not be used for self-referencing, the DOIs inserted should be for OTHER related tables.

The documentation for this feature can be found here: `Linking tables`_.

.. _`Linking tables`: https://hepdata-submission.readthedocs.io/en/latest/bidirectional.html#linking-tables
Expand Down
Loading