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

generate-docs.sh should support versioning #13

Open
ksdme opened this issue May 22, 2020 · 2 comments
Open

generate-docs.sh should support versioning #13

ksdme opened this issue May 22, 2020 · 2 comments

Comments

@ksdme
Copy link
Contributor

ksdme commented May 22, 2020

Such as,

  • docs/stdlib/collections/
  • docs/stdlib/collections/v0.x.y/
@ziflex
Copy link
Member

ziflex commented May 23, 2020

Alternatively, we could just have an additional line comments like “since x.x.x”.
It will keep the documentation easy to maintain.
The only downside of this approach is that if we introduce changes in API documentation will contain only recent version.

@ksdme
Copy link
Contributor Author

ksdme commented May 23, 2020

I think we should do both, maintain previous versions while also indicating the minium required version for a function. Doing the versioning thing should be easy as the script would just need to take one additional parameter and change it's output directory to use the one with version suffix, doing the latter would however either require updating comments of each function or using the git tree to find out when the function was first introduced, this however wouldn't indicate stability.

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