Viper_VSCode/architecture/generated/features/feat-documentation-and-comments.md

Documentation and Comments

Feature path: Documentation and Comments

Implementation summary

• Files: 3
• Symbols: 58

Primary files

These are the main implementation files attached to this semantic node.

File	Summary
packages/pyright/packages/pyright-internal/src/analyzer/commentUtils.ts	Parses pyright-specific comments to adjust diagnostic rule settings and collect comment diagnostics
packages/pyright/packages/pyright-internal/src/analyzer/docStringConversion.ts	Converts Python docstrings into Markdown or cleaned plaintext for documentation and display
packages/pyright/packages/pyright-internal/src/analyzer/docStringUtils.ts	Parses Python docstrings and extracts parameter and attribute docs in Epytext, reST, and Google styles

Symbol preview (40 of 58)

Symbol	Kind	Source
getFileLevelDirectives	function	packages/pyright/packages/pyright-internal/src/analyzer/commentUtils.ts
_applyStrictRules	function	packages/pyright/packages/pyright-internal/src/analyzer/commentUtils.ts
_applyStandardRules	function	packages/pyright/packages/pyright-internal/src/analyzer/commentUtils.ts
_applyBasicRules	function	packages/pyright/packages/pyright-internal/src/analyzer/commentUtils.ts
_overrideRules	function	packages/pyright/packages/pyright-internal/src/analyzer/commentUtils.ts
_overwriteRules	function	packages/pyright/packages/pyright-internal/src/analyzer/commentUtils.ts
_parsePyrightComment	function	packages/pyright/packages/pyright-internal/src/analyzer/commentUtils.ts
_parsePyrightOperand	function	packages/pyright/packages/pyright-internal/src/analyzer/commentUtils.ts
_parseDiagLevel	function	packages/pyright/packages/pyright-internal/src/analyzer/commentUtils.ts
_parseBoolSetting	function	packages/pyright/packages/pyright-internal/src/analyzer/commentUtils.ts
_trimTextWithRange	function	packages/pyright/packages/pyright-internal/src/analyzer/commentUtils.ts
convertDocStringToMarkdown	function	packages/pyright/packages/pyright-internal/src/analyzer/docStringConversion.ts
convertDocStringToPlainText	function	packages/pyright/packages/pyright-internal/src/analyzer/docStringConversion.ts
DocStringConverter	class	packages/pyright/packages/pyright-internal/src/analyzer/docStringConversion.ts
DocStringConverter.convert	method	packages/pyright/packages/pyright-internal/src/analyzer/docStringConversion.ts
DocStringConverter._eatLine	method	packages/pyright/packages/pyright-internal/src/analyzer/docStringConversion.ts
DocStringConverter._currentLineOrUndefined	method	packages/pyright/packages/pyright-internal/src/analyzer/docStringConversion.ts
DocStringConverter._currentLine	method	packages/pyright/packages/pyright-internal/src/analyzer/docStringConversion.ts
DocStringConverter._currentIndent	method	packages/pyright/packages/pyright-internal/src/analyzer/docStringConversion.ts
DocStringConverter._prevIndent	method	packages/pyright/packages/pyright-internal/src/analyzer/docStringConversion.ts
DocStringConverter._lineAt	method	packages/pyright/packages/pyright-internal/src/analyzer/docStringConversion.ts
DocStringConverter._nextBlockIndent	method	packages/pyright/packages/pyright-internal/src/analyzer/docStringConversion.ts
DocStringConverter._currentLineIsOutsideBlock	method	packages/pyright/packages/pyright-internal/src/analyzer/docStringConversion.ts
DocStringConverter._currentLineWithinBlock	method	packages/pyright/packages/pyright-internal/src/analyzer/docStringConversion.ts
DocStringConverter._pushAndSetState	method	packages/pyright/packages/pyright-internal/src/analyzer/docStringConversion.ts
DocStringConverter._popState	method	packages/pyright/packages/pyright-internal/src/analyzer/docStringConversion.ts
DocStringConverter._parseText	method	packages/pyright/packages/pyright-internal/src/analyzer/docStringConversion.ts
DocStringConverter._formatPlainTextIndent	method	packages/pyright/packages/pyright-internal/src/analyzer/docStringConversion.ts
DocStringConverter._convertIndent	method	packages/pyright/packages/pyright-internal/src/analyzer/docStringConversion.ts
DocStringConverter._escapeHtml	method	packages/pyright/packages/pyright-internal/src/analyzer/docStringConversion.ts
DocStringConverter._appendTextLine	method	packages/pyright/packages/pyright-internal/src/analyzer/docStringConversion.ts
DocStringConverter._preprocessTextLine	method	packages/pyright/packages/pyright-internal/src/analyzer/docStringConversion.ts
DocStringConverter._parseEmpty	method	packages/pyright/packages/pyright-internal/src/analyzer/docStringConversion.ts
DocStringConverter._beginMinIndentCodeBlock	method	packages/pyright/packages/pyright-internal/src/analyzer/docStringConversion.ts
DocStringConverter._beginBacktickBlock	method	packages/pyright/packages/pyright-internal/src/analyzer/docStringConversion.ts
DocStringConverter._parseBacktickBlock	method	packages/pyright/packages/pyright-internal/src/analyzer/docStringConversion.ts
DocStringConverter._beginDocTest	method	packages/pyright/packages/pyright-internal/src/analyzer/docStringConversion.ts
DocStringConverter._parseDocTest	method	packages/pyright/packages/pyright-internal/src/analyzer/docStringConversion.ts
DocStringConverter._beginLiteralBlock	method	packages/pyright/packages/pyright-internal/src/analyzer/docStringConversion.ts
DocStringConverter._parseLiteralBlock	method	packages/pyright/packages/pyright-internal/src/analyzer/docStringConversion.ts
18 additional symbols omitted

Dependencies

Imported by:

• packages/pyright/packages/pyright-internal/src/analyzer/decorators.ts
• packages/pyright/packages/pyright-internal/src/analyzer/sourceFile.ts
• packages/pyright/packages/pyright-internal/src/common/docStringService.ts

Imports:

• packages/pyright/packages/pyright-internal/src/common/configOptions.ts
• packages/pyright/packages/pyright-internal/src/common/debug.ts
• packages/pyright/packages/pyright-internal/src/common/diagnostic.ts
• packages/pyright/packages/pyright-internal/src/common/diagnosticRules.ts
• packages/pyright/packages/pyright-internal/src/common/positionUtils.ts
• packages/pyright/packages/pyright-internal/src/common/textRange.ts
• packages/pyright/packages/pyright-internal/src/common/textRangeCollection.ts
• packages/pyright/packages/pyright-internal/src/localization/localize.ts
• packages/pyright/packages/pyright-internal/src/parser/tokenizerTypes.ts