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 JSDoc for Object module #69

Open
11 tasks
Tracked by #76
MajorLift opened this issue Nov 26, 2023 · 0 comments
Open
11 tasks
Tracked by #76

Add JSDoc for Object module #69

MajorLift opened this issue Nov 26, 2023 · 0 comments
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers

Comments

@MajorLift
Copy link
Collaborator

MajorLift commented Nov 26, 2023

As part of our initiative to overhaul documentation for this library, we need JSDoc comments to be written for the following Object module methods, so that they can be automatically published using TypeDoc and GitHub Pages.

  • At
  • AtPath
  • DeepInputOf
  • DeepMapValues
  • Emplace
  • Keys
  • MapKeys
  • MapValues
  • Merge
  • Paths
  • Values

The JSDoc comments must adhere to the guidelines laid out in style-guide/jsdoc.md.

Here are two previous examples where the style guide was fed to an AI assistant to successfully generate documentation in JSDoc format.

@MajorLift MajorLift self-assigned this Nov 26, 2023
@MajorLift MajorLift added documentation Improvements or additions to documentation good first issue Good for newcomers labels Nov 26, 2023
@MajorLift MajorLift removed their assignment Nov 26, 2023
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 good first issue Good for newcomers
Projects
None yet
Development

No branches or pull requests

1 participant