Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Remove unnecessary docstrings #754

Merged
merged 22 commits into from
Feb 16, 2023
Merged

Remove unnecessary docstrings #754

merged 22 commits into from
Feb 16, 2023

Conversation

stelmo
Copy link
Collaborator

@stelmo stelmo commented Feb 15, 2023

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

@stelmo stelmo force-pushed the mo-rm-unnecessary-docstrings branch from 16d4966 to b7e228c Compare February 15, 2023 21:57
@codecov
Copy link

codecov bot commented Feb 15, 2023

Codecov Report

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

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
@@           Coverage Diff           @@
##             next     #754   +/-   ##
=======================================
  Coverage   88.49%   88.49%           
=======================================
  Files          88       88           
  Lines        2103     2103           
=======================================
  Hits         1861     1861           
  Misses        242      242           
Impacted Files Coverage Δ
src/types/accessors/AbstractMetabolicModel.jl 77.61% <ø> (ø)
src/types/models/BalancedGrowthCommunityModel.jl 98.21% <ø> (ø)
src/types/models/JSONModel.jl 99.01% <0.00%> (ø)
src/types/models/ObjectModel.jl 100.00% <ø> (ø)
src/types/models/SBMLModel.jl 92.08% <ø> (ø)
src/types/models/Serialized.jl 88.88% <ø> (ø)
src/types/wrappers/EnzymeConstrainedModel.jl 92.68% <ø> (ø)
src/types/wrappers/MatrixCoupling.jl 89.47% <ø> (ø)
src/types/wrappers/MaxMinDrivingForceModel.jl 95.77% <ø> (ø)
...types/wrappers/SimplifiedEnzymeConstrainedModel.jl 66.66% <ø> (ø)
... and 2 more

Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here.

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

@stelmo
Copy link
Collaborator Author

stelmo commented Feb 15, 2023

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

@stelmo stelmo requested a review from exaexa February 15, 2023 22:53
@stelmo
Copy link
Collaborator Author

stelmo commented Feb 16, 2023

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

@exaexa exaexa added the 🪓 code axing 🪓 Use this for PRs that remove code which might still be re-used later label Feb 16, 2023
@exaexa exaexa added this to the v2.0 milestone Feb 16, 2023
Copy link
Collaborator

@exaexa exaexa left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

a good 🪓

@stelmo stelmo merged commit c5ac155 into next Feb 16, 2023
@stelmo stelmo deleted the mo-rm-unnecessary-docstrings branch February 16, 2023 15:19
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
🪓 code axing 🪓 Use this for PRs that remove code which might still be re-used later
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants