search

LCSB-BioCore / COBREXA.jl

Constraint-Based Reconstruction and EXascale Analysis
https://lcsb-biocore.github.io/COBREXA.jl/
Apache License 2.0
42 stars 8 forks source link

Remove unnecessary docstrings #754

Closed stelmo closed 1 year ago

stelmo commented 1 year ago

Some docstrings are not necessary (especially generic inherited methods). Remove them

codecov[bot] commented 1 year ago

Codecov Report

Base: 88.49% // Head: 88.49% // No change to project coverage :thumbsup:

Coverage data is based on head (e259c18) compared to base (33eef00). Patch coverage: 75.00% of modified lines in pull request are covered.

Additional details and impacted files ```diff @@ Coverage Diff @@ ## next #754 +/- ## ======================================= Coverage 88.49% 88.49% ======================================= Files 88 88 Lines 2103 2103 ======================================= Hits 1861 1861 Misses 242 242 ``` | [Impacted Files](https://codecov.io/gh/LCSB-BioCore/COBREXA.jl/pull/754?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=LCSB-BioCore) | Coverage Δ | | |---|---|---| | [src/types/accessors/AbstractMetabolicModel.jl](https://codecov.io/gh/LCSB-BioCore/COBREXA.jl/pull/754?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=LCSB-BioCore#diff-c3JjL3R5cGVzL2FjY2Vzc29ycy9BYnN0cmFjdE1ldGFib2xpY01vZGVsLmps) | `77.61% <ø> (ø)` | | | [src/types/models/BalancedGrowthCommunityModel.jl](https://codecov.io/gh/LCSB-BioCore/COBREXA.jl/pull/754?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=LCSB-BioCore#diff-c3JjL3R5cGVzL21vZGVscy9CYWxhbmNlZEdyb3d0aENvbW11bml0eU1vZGVsLmps) | `98.21% <ø> (ø)` | | | [src/types/models/JSONModel.jl](https://codecov.io/gh/LCSB-BioCore/COBREXA.jl/pull/754?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=LCSB-BioCore#diff-c3JjL3R5cGVzL21vZGVscy9KU09OTW9kZWwuamw=) | `99.01% <0.00%> (ø)` | | | [src/types/models/ObjectModel.jl](https://codecov.io/gh/LCSB-BioCore/COBREXA.jl/pull/754?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=LCSB-BioCore#diff-c3JjL3R5cGVzL21vZGVscy9PYmplY3RNb2RlbC5qbA==) | `100.00% <ø> (ø)` | | | [src/types/models/SBMLModel.jl](https://codecov.io/gh/LCSB-BioCore/COBREXA.jl/pull/754?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=LCSB-BioCore#diff-c3JjL3R5cGVzL21vZGVscy9TQk1MTW9kZWwuamw=) | `92.08% <ø> (ø)` | | | [src/types/models/Serialized.jl](https://codecov.io/gh/LCSB-BioCore/COBREXA.jl/pull/754?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=LCSB-BioCore#diff-c3JjL3R5cGVzL21vZGVscy9TZXJpYWxpemVkLmps) | `88.88% <ø> (ø)` | | | [src/types/wrappers/EnzymeConstrainedModel.jl](https://codecov.io/gh/LCSB-BioCore/COBREXA.jl/pull/754?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=LCSB-BioCore#diff-c3JjL3R5cGVzL3dyYXBwZXJzL0VuenltZUNvbnN0cmFpbmVkTW9kZWwuamw=) | `92.68% <ø> (ø)` | | | [src/types/wrappers/MatrixCoupling.jl](https://codecov.io/gh/LCSB-BioCore/COBREXA.jl/pull/754?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=LCSB-BioCore#diff-c3JjL3R5cGVzL3dyYXBwZXJzL01hdHJpeENvdXBsaW5nLmps) | `89.47% <ø> (ø)` | | | [src/types/wrappers/MaxMinDrivingForceModel.jl](https://codecov.io/gh/LCSB-BioCore/COBREXA.jl/pull/754?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=LCSB-BioCore#diff-c3JjL3R5cGVzL3dyYXBwZXJzL01heE1pbkRyaXZpbmdGb3JjZU1vZGVsLmps) | `95.77% <ø> (ø)` | | | [...types/wrappers/SimplifiedEnzymeConstrainedModel.jl](https://codecov.io/gh/LCSB-BioCore/COBREXA.jl/pull/754?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=LCSB-BioCore#diff-c3JjL3R5cGVzL3dyYXBwZXJzL1NpbXBsaWZpZWRFbnp5bWVDb25zdHJhaW5lZE1vZGVsLmps) | `66.66% <ø> (ø)` | | | ... and [2 more](https://codecov.io/gh/LCSB-BioCore/COBREXA.jl/pull/754?src=pr&el=tree-more&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=LCSB-BioCore) | | Help us with your feedback. Take ten seconds to tell us [how you rate us](https://about.codecov.io/nps?utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=LCSB-BioCore). Have a feature suggestion? [Share it here.](https://app.codecov.io/gh/feedback/?utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=LCSB-BioCore)

:umbrella: View full report at Codecov.
:loudspeaker: Do you have feedback about the report comment? Let us know in this issue.

stelmo commented 1 year ago

Not sure if this is better or worse. Also not sure why ?reaction_stoichiometry still displays for MatrixModelWithCoupling

stelmo commented 1 year ago

All docstrings removed, but where appropriate I added information to the model constructors to make it clearer where the accessors might surprise people