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

Docs: Notify that an entry point is required for creating a data plugin #5907

Merged
merged 4 commits into from
Mar 4, 2023
Merged

Docs: Notify that an entry point is required for creating a data plugin #5907

Changes from 1 commit
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
cc7e7ce
Docs: Notify that an entry point is required for creating a data plugin
AhmedBasem20 Feb 26, 2023
7402d4f
Docs: Notify that an entry point is required for creating a data plug…
AhmedBasem20 Mar 3, 2023
be9fe3e
Merge branch 'main' of https://github.com/aiidateam/aiida-core into d…
AhmedBasem20 Mar 3, 2023
af64269
Update docs/source/topics/data_types.rst
sphuber Mar 4, 2023
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/source/topics/data_types.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1122,6 +1122,10 @@ Creating a new data type is as simple as creating a new sub class of the base :c
class NewData(Data):
"""A new data type that wraps a single value."""

.. note::

You must register a new data entry point. See `aiida.data <https://aiida.readthedocs.io/projects/aiida-core/en/latest/topics/plugins.html#aiida-data>`
AhmedBasem20 marked this conversation as resolved.
Show resolved Hide resolved

At this point, our new data type does nothing special.
Typically, one creates a new data type to represent a specific type of data.
For the purposes of this example, let's assume that the goal of our ``NewData`` type is to store a single numerical value.
Expand Down