Skip to content
New issue

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

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

Already on GitHub? # to your account

Documentation separate from code #128

Closed
cyianor opened this issue Oct 14, 2020 · 2 comments
Closed

Documentation separate from code #128

cyianor opened this issue Oct 14, 2020 · 2 comments

Comments

@cyianor
Copy link

cyianor commented Oct 14, 2020

Hi,

I am writing a pull request to propose to include factor rotations into MultivariateStats.jl and was wondering if there is a concrete reason why this package doesn't use Documenter.jl's capability to create documentation from the source code. I personally like the GitHub source code links it adds and the formatting gets a bit more uniform with respect to Base Julia's documentation packages as well. It also seems to me that it is easier to forget to update the separate documentation than the documentation directly in the source code.

@wildart
Copy link
Collaborator

wildart commented Oct 14, 2020

The reason is the lack of resources. You are welcome to present in the documentation as docstrings which I hope the future will be incorporated in a proper Documenter based docs.

@wildart
Copy link
Collaborator

wildart commented Jan 26, 2022

Documenter docs available from v0.9.0.

@wildart wildart closed this as completed Jan 26, 2022
# for free to join this conversation on GitHub. Already have an account? # to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants