Docker-in-Docker (DinD) capabilities of public runners deactivated. More info

Commit 8764280b authored by LE GAC Renaud's avatar LE GAC Renaud
Browse files

Update docstring for records classes

parent bb9d1620
......@@ -7,7 +7,7 @@ import pprint
class RecordHep(dict):
"""Base class for JSON record coming from inspirehep.net version v2.
Schema documentation is defined here:
Schema for records are documented here:
https://inspire-schemas.readthedocs.io/en/latest/schemas/
Args:
......
......@@ -11,11 +11,14 @@ from .recordheppubli import RecordHepPubli
class RecordHepConf(RecordHepPubli):
"""Conference proceeding from inspirehep.net version 2.
Schema for conference paper is documented here:
https://inspire-schemas.readthedocs.io/en/latest/schemas/
Attributes:
conference (dict):
metadata of the conference
schema is https://inspirehep.net/s…records/conferences.json
Schema for conference metadata is document here:
https://inspire-schemas.readthedocs.io/en/latest/schemas/
"""
......
......@@ -11,7 +11,7 @@ from store_tools.pluginpublicationinfo import PluginPublicationInfo
class RecordHepPubli(RecordHep, PluginAuthors, PluginPublicationInfo):
"""Article, preprint and proceeding from inspirehep.net version 2.
Schema documentation is defined here:
Schema for publication is documented here:
https://inspire-schemas.readthedocs.io/en/latest/schemas/
"""
......@@ -47,9 +47,9 @@ class RecordHepPubli(RecordHep, PluginAuthors, PluginPublicationInfo):
+---------------+--------------------------------+
Note:
After running this method, the field ``authors`` is always defined.
It contains one entry with empty strings when the field does not
exist.
After running this method, the attribute ``df_authors`` is defined.
It contains one entry with empty strings when the file ``authors``
is not defined.
"""
authors = self.get("authors", None)
......@@ -113,9 +113,9 @@ class RecordHepPubli(RecordHep, PluginAuthors, PluginPublicationInfo):
+------------+--------------------------------+
Note:
* After running this method, the field ``publication_info``
is always defined. It contains one entry with empty strings
when the field does not exist.
* After running this method, the attribute ``df_info``
is defined. It contains one entry with empty strings
when the ``publication_info`` field does not exist.
* In order to deal with erratum entry are sorter by year
and volume.
......
......@@ -150,9 +150,9 @@ class RecordPubli(Record, PluginAuthors, PluginPublicationInfo):
+---------------+--------------------------------+
Note:
After running this method, the field ``authors`` is always defined.
It contains one entry with empty strings when the field does not
exist.
After running this method, the attribute ``df_authors`` is defined.
It contains one entry with empty strings when the ``authors``
field does not exist.
"""
if "authors" not in self:
......@@ -222,9 +222,9 @@ class RecordPubli(Record, PluginAuthors, PluginPublicationInfo):
+------------+--------------------------------+
Note:
* After running this method, the field ``publication_info``
is always defined. It contains one entry with empty strings
when the field does not exist.
* After running this method, the attribute ``df_info`` is defined.
It contains one entry with empty strings when the field
``publication_info`` does not exist.
* In order to deal with erratum entry are sorter by year
and volume.
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment