Finally add DocStringExtensions 🥳

[stelmo]

This should reduce docstring out-of-sync issues!

[laurentheirendt]

this is cool 👍🏼

[codecov]

Codecov Report

Merging #661 (7ed54eb) into develop (5ca5200) will not change coverage.
The diff coverage is n/a.

@@           Coverage Diff            @@
##           develop     #661   +/-   ##
========================================
  Coverage    91.05%   91.05%           
========================================
  Files           82       82           
  Lines         2012     2012           
========================================
  Hits          1832     1832           
  Misses         180      180           

Impacted Files	Coverage Δ
src/COBREXA.jl	0.00% <ø> (ø)
src/analysis/envelopes.jl	100.00% <ø> (ø)
src/analysis/flux_balance_analysis.jl	100.00% <ø> (ø)
src/analysis/flux_variability_analysis.jl	93.54% <ø> (ø)
src/analysis/gecko.jl	100.00% <ø> (ø)
src/analysis/max_min_driving_force.jl	93.33% <ø> (ø)
src/analysis/minimize_metabolic_adjustment.jl	66.66% <ø> (ø)
src/analysis/modifications/crowding.jl	100.00% <ø> (ø)
src/analysis/modifications/generic.jl	77.27% <ø> (ø)
src/analysis/modifications/knockout.jl	100.00% <ø> (ø)
... and 62 more

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

[exaexa]

Ok this is a good job. I've got a few questions but otherwise looks okay.

• what about the extra operators in src/reconstruction/Reactions.jl? (could we have the typed signature and print out the intended inline usage in an example?)
• what about code generated by macros (e.g. in src/base/macros/model_wrapper.jl), is it possible to smuggle TYPEDSIGNATURES in there?
• is there no way to print out the const typedefs (e.g. in src/base/types/abstract/MetabolicModel.jl)

[stelmo]

Ok this is a good job. I've got a few questions but otherwise looks okay.

• what about the extra operators in src/reconstruction/Reactions.jl? (could we have the typed signature and print out the intended inline usage in an example?)

They looked weird so I left them, but tbh, there is no good reason for leaving them. Adding them!

• what about code generated by macros (e.g. in src/base/macros/model_wrapper.jl), is it possible to smuggle TYPEDSIGNATURES in there?

Inserting docstrings inside a macro that generates documentation seems to be an issue..

• is there no way to print out the const typedefs (e.g. in src/base/types/abstract/MetabolicModel.jl)

I did not find anything for constants... Seems they will just be manual

[exaexa]

All answered I guess. Re the operators, since they are user-facing and the involved types are completely internal I guess we can do without the precise doc.

[stelmo]

/format

[github-actions]

✔️ Auto-formatting triggered by this comment succeeded, commited as 7ed54eb