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

Link code references in low-level API docstrings #2

Open
3 tasks
oubiwann opened this issue Apr 30, 2016 · 0 comments
Open
3 tasks

Link code references in low-level API docstrings #2

oubiwann opened this issue Apr 30, 2016 · 0 comments

Comments

@oubiwann
Copy link
Member

Originally filed at clojang/clojang#14.

Right now the docstrings in the jiface API has the following issues:

  • Some object names are just code text instead of being links to the documentation for that object
  • Some linked code points to the javadocs, some to the low-level API docs
  • parameters and return values are not discussed

These all need to be fixed:

  • Ensure all code text points to the low-level documentation for the given namespace or function
  • Ensure that the JInterface objects are referenced only when saying what is wrapped (and then, link to the javadocs)
  • Ensure that docstrings have notes about the return value and the possible types for function arguments)
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

1 participant