Heuristic + Matrix clean up, added Sequence to _util.py #526
Conversation
|
|
||
|
|
||
| # I/O | ||
| def string(mat, val_format="{0:>8.3f}"): | ||
| def string(mat: Sequence[Sequence[float]], val_format="{0:>8.3f}") -> str: |
There was a problem hiding this comment.
Function signature looks good. Let's take out the types in the doc string, since they are wrong. Also, I see that the docs describe a non-existent precision parameter. We should replace that with:
:param val_format: A number-formatting string, such as "{:.3f}"
| @@ -0,0 +1,4 @@ | |||
| # automol.heuristic | |||
| ```{eval-rst} | |||
There was a problem hiding this comment.
I would like to have all of the util functions on the same page. We can do that by putting the eval-rst blocks for the util submodules directly into util.md, below the current eval-rst block there:
# automol.util
some words
\```{eval-rst} (Remove the slashes -- those are to get my back ticks to show up.)
.. automodule:: automol.util
\```
\```{eval-rst}
.. automodule:: automol.util.heuristic
\```
\```{eval-rst}
.. automodule:: automol.util.matrix
\```
Etc.
| @@ -0,0 +1,5 @@ | |||
| # automol.matrix | |||
There was a problem hiding this comment.
See comment for heuristic.md I want this automodule block moved into util.md so that all of the util functions are in one place.
| @@ -6,4 +6,6 @@ Welcome to my documentation website... | |||
| :hidden: | |||
| automol/inchi_key.md | |||
| automol/util.md | |||
| automol/heuristic.md | |||
| automol/matrix.md | |||
There was a problem hiding this comment.
See above. These will be taken out.
| @@ -5,6 +5,8 @@ FILES=( | |||
| "automol/error.py" | |||
| "automol/util/_util.py" | |||
| "automol/util/__init__.py" | |||
| "automol/util/heuristic.py" | |||
| "automol/util/matrix.py" | |||
There was a problem hiding this comment.
These stay in, since I do still want the linting to be run on the files. I just don't want a separate page for them in the documentation.
No description provided.