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 the "Platform documentation" page on how to write docs #2393

Open
panglesd opened this issue May 3, 2024 · 3 comments
Open

Improve the "Platform documentation" page on how to write docs #2393

panglesd opened this issue May 3, 2024 · 3 comments
Labels

Comments

@panglesd
Copy link
Contributor

panglesd commented May 3, 2024

The platform tool guide on how to write documentation is minimal.

I think it would benefit from some examples, explanation on what is a docstring and how it is attached to an item, some explanation of the (basic) syntax, etc. Another content could be "what kind of content to put in docstrings", but this is a bit more personal.

I can give it a shot if there is no volunteer!

@panglesd
Copy link
Contributor Author

panglesd commented May 3, 2024

I would also think it would be worth adding a link to it directly from the "Overview" page of "Learning" (maybe only once it is improved), but I don't see which section it could replace...

@cuihtlauac
Copy link
Collaborator

I can give it a shot if there is no volunteer!

Please do! Yes, this guide needs to be updated.

@sabine sabine added help wanted good first issue Good for newcomers labels May 6, 2024
@NoahTheDuke
Copy link
Contributor

NoahTheDuke commented Jul 26, 2024

I think a good first step would be to just add an example docstring in the section on Defining Global Functions. I searched "docstring" on every page in the Language and Guides and never found anything other than the "Generating documentation with odoc", which is good for library authors but unhelpful for language learners.

On second thought, this would be better suited for A Tour of Ocaml.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
Status: 📋 Backlog
Development

No branches or pull requests

4 participants