Skip to content

Commit

Permalink
small docs update #5
Browse files Browse the repository at this point in the history
  • Loading branch information
cb-Hades committed Aug 28, 2024
1 parent 6b51947 commit dbd1837
Show file tree
Hide file tree
Showing 2 changed files with 3 additions and 13 deletions.
5 changes: 3 additions & 2 deletions docs/source/dev-notes.rst
Original file line number Diff line number Diff line change
Expand Up @@ -21,8 +21,9 @@ The version in this release has as of yet only be tested on prokaryote genomes.
``dev``: ONGOING
^^^^^^^^^^^^^^^^

Development branch.
Currently, features marked as future update throughout the documentation are worked on.
| Development branch.
| Place to fix errors, chase bugs and polish the code.
| Additionally, features marked as future update throughout the documentation are actively being worked on.
Further branches
^^^^^^^^^^^^^^^^
Expand Down
11 changes: 0 additions & 11 deletions docs/source/help.rst
Original file line number Diff line number Diff line change
Expand Up @@ -14,17 +14,6 @@ Pydantic
Pydantic warning :code:`underscore_attrs_are_private has been removed` has not - yet - caused any issues.
However, the core of the problems (= what causes the warning) has yet to be identified.

BOFdat
^^^^^^

For `BOFdat <https://github.com/jclachance/BOFdat>`_, to be running as expected,
one needs to change :code:`solution.f` to :code:`solution.objective_value` in the :code:`coenzymes_and_ions.py` file of the tool's files.

.. warning::

The change in the files for BOFdat is neccessary, otherwise it will raise an error while running the connected functions.


FAQs
----

Expand Down

0 comments on commit dbd1837

Please sign in to comment.