Skip to content

Add JSDoc comments to functions #130

New issue
New issue
Closed
Closed
Add JSDoc comments to functions#130
Labels
good first issueGood for newcomersmodule/docsModule documentation changes

Description

@grant
grant
opened on May 6, 2020

This SDK has many functions that don't have comments, making the code more difficult to understand. Sometimes the comments don't make sense or have spelling errors.

Ideally we add comments to the functions.

Example: receiver_structured.js

Activity

  1. lance
    added
    module/docsModule documentation changes
    good first issueGood for newcomers
    on May 7, 2020

  2. lance commented on May 9, 2020

    @lance
    lance
    on May 9, 2020
    Member

    I agree - JSDoc is super important. Ideally, I'd like to work to narrow and simplify the exposed API so that we can know best how to prioritize effort when documenting functions. Maybe we can start with the CloudEvent and HTTPReceiver classes, since those are the most accessible/easiest to use parts of the API at the moment.

  3. lance
    added 2 commits that reference this issue on May 9, 2020

    docs: add JSDocs for top level API objects

    2703cf6

    docs: add JSDocs for top level API objects

    2bcfc52

  4. lance commented on May 21, 2020

    @lance
    lance
    on May 21, 2020
    Member

    Now that we have JSDoc everywhere and are publishing it, this can be closed.

  5. lance
    closed this as completedon May 21, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    good first issueGood for newcomersmodule/docsModule documentation changes

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions