Skip to content

Commit

Permalink
More docs tweaks SO--
Browse files Browse the repository at this point in the history
  • Loading branch information
dormrod committed Feb 11, 2025
1 parent edc376d commit ac4aae2
Show file tree
Hide file tree
Showing 2 changed files with 3 additions and 1 deletion.
2 changes: 1 addition & 1 deletion doc/source/components/jobanalysis.rst
Original file line number Diff line number Diff line change
Expand Up @@ -124,4 +124,4 @@ API
~~~~~~~~~~~~~~~~~~~~~~~~~

.. autoclass:: JobAnalysis
:exclude-members: __weakref__, _Field, _get_field_analysis, _add_standard_field, _remove_standard_field, _is_empty_value, _get_job_settings, _repr_html_, __dir__
:exclude-members: __weakref__, _Field, _get_field_analysis, _is_empty_value, _get_job_settings, _repr_html_, __dir__
2 changes: 2 additions & 0 deletions tools/job_analysis.py
Original file line number Diff line number Diff line change
Expand Up @@ -1303,6 +1303,7 @@ def add_standard_fields(self, keys: Sequence["JobAnalysis.StandardField"]) -> "J
Adds multiple standard fields to the analysis.
These are:
* ``Path``: for |Job| attribute :attr:`~scm.plams.core.basejob.Job.path`
* ``Name``: for |Job| attribute :attr:`~scm.plams.core.basejob.Job.name`
* ``OK``: for |Job| method :meth:`~scm.plams.core.basejob.Job.ok`
Expand Down Expand Up @@ -1345,6 +1346,7 @@ def add_standard_field(self, key: "JobAnalysis.StandardField") -> "JobAnalysis":
Adds a standard field to the analysis.
These are:
* ``Path``: for |Job| attribute :attr:`~scm.plams.core.basejob.Job.path`
* ``Name``: for |Job| attribute :attr:`~scm.plams.core.basejob.Job.name`
* ``OK``: for |Job| method :meth:`~scm.plams.core.basejob.Job.ok`
Expand Down

0 comments on commit ac4aae2

Please sign in to comment.