Skip to content

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

Open

Description

@theRealPadster

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.

Activity

  1. theRealPadster commented on Sep 25, 2020

    @theRealPadster
    OwnerAuthor

    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.

  2. theRealPadster commented on Aug 5, 2021

    @theRealPadster
    OwnerAuthor

    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.

  3. theRealPadster commented on Aug 6, 2021

    @theRealPadster
    OwnerAuthor

    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

Metadata

Metadata

Labels

documentationImprovements or additions to documentation

Projects

No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions