google / google/styleguide

jsguide: Unclear rule - Indented four spaces for Line-wrapped block tags

Open
#594 0 comments 0 reactions 0 assignees View on GitHub
lang:js question
Dominant language
HTML
Stars
39.6k
Forks
12.9k
Avg merge
42m
Merged PRs (30d)
15

Description

https://google.github.io/styleguide/jsguide.html#jsdoc-line-wrapping

Line-wrapped block tags are indented four spaces. Wrapped description text may be lined up with the description on previous lines, but this horizontal alignment is discouraged.

- Both below have same issues - when extra comments are edited:
- Line-wrapped block tags are indented four spaces.
- Wrapped description text may be lined up with the description on previous lines, but this horizontal alignment is discouraged.

- Also, why not have them on with new blank lines, when long description?
- Or, why not do similar to @fileoverview - "Wrapped lines are not indented."?

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.