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

Update docs to more clearly outline all supported parameters for each function #5

Open
theRealPadster opened this issue Sep 21, 2020 · 3 comments
Assignees
Labels
documentation Improvements or additions to documentation

Comments

@theRealPadster
Copy link
Owner

Have a section for each module that outlines what params are supported. They're mostly the same as the ones from the official Diffbot docs, but some differ, like boolean fields, and not all fields are supported for each module.

@theRealPadster theRealPadster added the documentation Improvements or additions to documentation label Sep 21, 2020
@theRealPadster
Copy link
Owner Author

Added links to the official Diffbot docs for each API in c4afe2a. This still doesn't explain any differences, like boolean fields or seeds being an array.

@theRealPadster theRealPadster self-assigned this Dec 27, 2020
@theRealPadster
Copy link
Owner Author

I have added a wiki page for the Analyze API, with a table outlining the supported params. This is just copied from the JSDocs. It might be a good idea to see if I can auto-generate the rest.

@theRealPadster
Copy link
Owner Author

Added more wiki pages.

This npm package may be useful for automatically generating documentation based on the jsdocs...

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

1 participant