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

Add protected method docs to generated documentation #1007

Open
wt opened this issue Oct 12, 2022 · 0 comments
Open

Add protected method docs to generated documentation #1007

wt opened this issue Oct 12, 2022 · 0 comments

Comments

@wt
Copy link

wt commented Oct 12, 2022

Summary

Can esdoc please be made to also output docs for the protected methods (like the constructor on the Driver class)?

Steps to reproduce

  1. Look at Neo4j javascript lib docs
  2. Look for Driver class

Expected behavior

I expect to see the docs for the constructor.

Actual behavior

There are no docs for the constructor, presumably because it is a protected method.

Other info

FWIW, it would also be nice to get docs for the types like the MetaInfo and DriverConfig.

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