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

Improve docstrings #136

Open
ArnoStrouwen opened this issue Sep 25, 2023 · 2 comments
Open

Improve docstrings #136

ArnoStrouwen opened this issue Sep 25, 2023 · 2 comments

Comments

@ArnoStrouwen
Copy link
Member

Such that makedocs warnonly = [:missing_docs, :cross_references] can be removed.

@paulflang
Copy link
Member

How would I do that, without having to remove the docstring for, e.g. get_unidirectional_components? get_unidirectional_components is not exported, so the docstring is just intended for the programmer, not the user. I think I could try

Modules = [Foo]
Private = false
Order = [:function]

in api.jl.

The issue with the cross-references comes from Model sitting in SBML, not SBMLTk. Do you know how to get that working @ArnoStrouwen ? In any case, if Private=false it would not work, cause SBML.Model is private...

@ArnoStrouwen
Copy link
Member Author

Maybe try not using cross references, use hard links to SBML?
For the docstrings I wouldn't worry right this moment, I think some tooling for that is coming later.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants