airbnb / airbnb/javascript

Documentation/docblocks

Open
#1,276 6 comments 2 reactions 0 assignees View on GitHub
editorial pull request wanted
Dominant language
JavaScript
Stars
148k
Forks
26.6k
PR merge metrics
No merged PRs in 30d

Description

I am wondering why there is no section of documentation or docblocks. Is it conventional to leave them out? What is the reason I don't see any docblocks in the open-sourced projects you guys have?

I would love to hear thoughts about using docblocks in Javascript. I find them really helpful when I am programming PHP. Especially if your IDE has support for it and can help you out with the documentation.

Contributor guide

No contributing guide indexed for this repository

Research direction

The issue names no files, tests, or entry points and asks for opinions about JavaScript docblocks rather than a specific documentation change. Read the existing discussion first; the work is not ready to start until the project decides whether docblocks belong in the style guide and defines the expected documentation scope.

Written by the indexing model from the issue text.

Assessment

Tech stack
javascript
Domain
documentation
Issue type
Documentation
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
20/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.