Skip to content

Commit

Permalink
Fix doc
Browse files Browse the repository at this point in the history
  • Loading branch information
shyuep committed Aug 8, 2018
1 parent 69e0a2b commit 6e1268c
Show file tree
Hide file tree
Showing 5 changed files with 5 additions and 18 deletions.
5 changes: 3 additions & 2 deletions custodian/feff/handlers.py
Original file line number Diff line number Diff line change
Expand Up @@ -32,10 +32,11 @@ class UnconvergedErrorHandler(ErrorHandler):
def __init__(self, output_filename='log1.dat'):
"""
Initializes the handler with the output file to check
Args:
output_filename (str): Filename for the log1.dat file. log1.dat file
contains the SCF calculation convergence information. Change this only
if it is different from the default (unlikely).
contains the SCF calculation convergence information. Change this only
if it is different from the default (unlikely).
"""
self.output_filename = output_filename

Expand Down
1 change: 1 addition & 0 deletions custodian/feff/interpreter.py
Original file line number Diff line number Diff line change
Expand Up @@ -36,6 +36,7 @@ def apply_actions(self, actions):
"""
Applies a list of actions to the FEFF Input Set and rewrites modified
files.
Args:
actions [dict]: A list of actions of the form {'file': filename,
'action': moddermodification} or {'dict': feffinput_key,
Expand Down
1 change: 1 addition & 0 deletions custodian/feff/jobs.py
Original file line number Diff line number Diff line change
Expand Up @@ -34,6 +34,7 @@ def __init__(self, feff_cmd, output_file="feff.out",
gzipped=False, gzipped_prefix='feff_out'):
"""
This constructor is used for a standard FEFF initialization
Args:
feff_cmd (str): the name of the full executable for running FEFF
output_file (str): Name of file to direct standard out to.
Expand Down
Binary file modified docs/doctrees/custodian.feff.doctree
Binary file not shown.
16 changes: 0 additions & 16 deletions docs_rst/custodian.qchem.rst
Original file line number Diff line number Diff line change
Expand Up @@ -10,22 +10,6 @@ Subpackages
Submodules
----------

custodian\.qchem\.deprecated\_handlers module
---------------------------------------------

.. automodule:: custodian.qchem.deprecated_handlers
:members:
:undoc-members:
:show-inheritance:

custodian\.qchem\.deprecated\_jobs module
-----------------------------------------

.. automodule:: custodian.qchem.deprecated_jobs
:members:
:undoc-members:
:show-inheritance:

custodian\.qchem\.handlers module
---------------------------------

Expand Down

0 comments on commit 6e1268c

Please sign in to comment.