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

Library doesn't have sufficient module documentation #36

Open
milesfrain opened this issue Oct 5, 2020 · 0 comments
Open

Library doesn't have sufficient module documentation #36

milesfrain opened this issue Oct 5, 2020 · 0 comments
Labels
type: documentation Improvements or additions to documentation.

Comments

@milesfrain
Copy link
Member

Is your change request related to a problem? Please describe.
As described in the documentation section of the Library Guidelines, Contributors libraries are expected to have mostly complete module documentation, preferably uploaded to Pursuit.

This library currently doesn't have sufficient module documentation -- many publicly-exported types and functions don't have any documentation comments.

Describe the solution you'd like
The library needs to have documentation comments on the majority (and preferably all) public types and functions. Once updated, we should tag a release and upload new module documentation to Pursuit so that folks can use it.

It's questionable whether we need to duplicate the official API docs for this wrapper library. Ideally, we could autogenerate our documentation by either scraping and/or linking to each function in the official API docs. Unfortunately, the official docs don't have anchor links, or at least they're broken, for example: https://ace.c9.io/#Editor.blockOutdent doesn't work.

So maybe a good partial solution is to just link to docs per section (and not per function). For example, at the top of this section:
https://pursuit.purescript.org/packages/purescript-ace/docs/Ace.ScrollBar
link to:
https://ace.c9.io/#nav=api&api=scrollbar

Additional context
See the Governance repository for more information about requirements in the Contributors organization.

@thomashoneyman thomashoneyman added type: documentation Improvements or additions to documentation. help wanted labels Oct 5, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
type: documentation Improvements or additions to documentation.
Development

No branches or pull requests

3 participants