Skip to content

Comments

docs(data_structures): doc comments on fields of Stack#15793

Merged
graphite-app[bot] merged 1 commit intomainfrom
11-17-docs_data_structures_doc_comments_on_fields_of_stack_
Nov 17, 2025
Merged

docs(data_structures): doc comments on fields of Stack#15793
graphite-app[bot] merged 1 commit intomainfrom
11-17-docs_data_structures_doc_comments_on_fields_of_stack_

Conversation

@overlookmotel
Copy link
Member

@overlookmotel overlookmotel commented Nov 17, 2025

Convert normal comments on Stack's struct fields to doc comments. Add doc comments on fields of SparseStack.

@github-actions github-actions bot added the C-docs Category - Documentation. Related to user-facing or internal documentation label Nov 17, 2025
Copy link
Member Author

overlookmotel commented Nov 17, 2025


How to use the Graphite Merge Queue

Add either label to this PR to merge it via the merge queue:

  • 0-merge - adds this PR to the back of the merge queue
  • hotfix - for urgent hot fixes, skip the queue and merge this PR next

You must have a Graphite account in order to use the merge queue. Sign up using this link.

An organization admin has enabled the Graphite Merge Queue in this repository.

Please do not merge from GitHub as this will restart CI on PRs being processed by the merge queue.

This stack of pull requests is managed by Graphite. Learn more about stacking.

Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull Request Overview

This PR converts regular comments to doc comments for the three private fields of the Stack struct, making them follow Rust documentation conventions.

Key Changes:

  • Converted inline comments (//) to doc comments (///) for the cursor, start, and end fields of the Stack struct

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

@codspeed-hq
Copy link

codspeed-hq bot commented Nov 17, 2025

CodSpeed Performance Report

Merging #15793 will not alter performance

Comparing 11-17-docs_data_structures_doc_comments_on_fields_of_stack_ (aabac4a) with main (65a3520)

Summary

✅ 37 untouched

@overlookmotel overlookmotel self-assigned this Nov 17, 2025
@overlookmotel overlookmotel force-pushed the 11-17-docs_data_structures_doc_comments_on_fields_of_stack_ branch from e50da92 to aabac4a Compare November 17, 2025 14:53
@graphite-app graphite-app bot added the 0-merge Merge with Graphite Merge Queue label Nov 17, 2025
@graphite-app
Copy link
Contributor

graphite-app bot commented Nov 17, 2025

Merge activity

Convert normal comments on `Stack`'s struct fields to doc comments. Add doc comments on fields of `SparseStack`.
@graphite-app graphite-app bot force-pushed the 11-17-docs_data_structures_doc_comments_on_fields_of_stack_ branch from aabac4a to c81a331 Compare November 17, 2025 16:02
@graphite-app graphite-app bot merged commit c81a331 into main Nov 17, 2025
21 checks passed
@graphite-app graphite-app bot deleted the 11-17-docs_data_structures_doc_comments_on_fields_of_stack_ branch November 17, 2025 16:08
@graphite-app graphite-app bot removed the 0-merge Merge with Graphite Merge Queue label Nov 17, 2025
overlookmotel pushed a commit that referenced this pull request Nov 24, 2025
### 💥 BREAKING CHANGES

- cbb27fd ast: [**BREAKING**] Add `TSGlobalDeclaration` type (#15712)
(overlookmotel)

### 🚀 Features

- 0c1f82b linter/plugins: Add `tokens` property to `Program` (#16020)
(overlookmotel)
- 6cff132 span: Add `Span::merge_within` method (#15869) (sapphi-red)
- 102365d allocator/vec: Add `Vec::into_bump_slice` method (#15770)
(Dunqing)

### 🐛 Bug Fixes

- e2ca770 codegen: Add support for printing type arguments in new
expressions (#15963) (Ives van Hoorne)
- 2bd3cb6 apps, editors, napi: Fix `oxlint-disable` comments (#16014)
(overlookmotel)
- 622cb5e parser: Preserve legal comments with @preserve/@license when
preceded by other annotations (#15929) (copilot-swe-agent)
- 7c46a9e transformer/tagged-template-transform: Handle `\n` escape
sequences (#15830) (Dunqing)
- f386efc minifier: Avoid generating invalid spans (#15778) (sapphi-red)
- d4ff004 parser: Forbid invalid modifiers on `module` and `global`
(#15723) (overlookmotel)
- 2191ae9 semantic: Allow reserved keywords in typescript ambient
contexts (#15495) (sapphi-red)
- 7d1ebad isolated-declarations: Incorrect nested namespace output in
isolated declarations (#15800) (copilot-swe-agent)

### ⚡ Performance

- b4b0ed8 transformer/typescript: Reverse order of checks (#15722)
(overlookmotel)

### 📚 Documentation

- c81a331 data_structures: Doc comments on fields of `Stack` (#15793)
(overlookmotel)
- cfae31d allocator: Use `allocator` as var name in examples (#15781)
(overlookmotel)

Co-authored-by: Boshen <[email protected]>
taearls pushed a commit to taearls/oxc that referenced this pull request Dec 11, 2025
…#15793)

Convert normal comments on `Stack`'s struct fields to doc comments. Add doc comments on fields of `SparseStack`.
taearls pushed a commit to taearls/oxc that referenced this pull request Dec 11, 2025
### 💥 BREAKING CHANGES

- cbb27fd ast: [**BREAKING**] Add `TSGlobalDeclaration` type (oxc-project#15712)
(overlookmotel)

### 🚀 Features

- 0c1f82b linter/plugins: Add `tokens` property to `Program` (oxc-project#16020)
(overlookmotel)
- 6cff132 span: Add `Span::merge_within` method (oxc-project#15869) (sapphi-red)
- 102365d allocator/vec: Add `Vec::into_bump_slice` method (oxc-project#15770)
(Dunqing)

### 🐛 Bug Fixes

- e2ca770 codegen: Add support for printing type arguments in new
expressions (oxc-project#15963) (Ives van Hoorne)
- 2bd3cb6 apps, editors, napi: Fix `oxlint-disable` comments (oxc-project#16014)
(overlookmotel)
- 622cb5e parser: Preserve legal comments with @preserve/@license when
preceded by other annotations (oxc-project#15929) (copilot-swe-agent)
- 7c46a9e transformer/tagged-template-transform: Handle `\n` escape
sequences (oxc-project#15830) (Dunqing)
- f386efc minifier: Avoid generating invalid spans (oxc-project#15778) (sapphi-red)
- d4ff004 parser: Forbid invalid modifiers on `module` and `global`
(oxc-project#15723) (overlookmotel)
- 2191ae9 semantic: Allow reserved keywords in typescript ambient
contexts (oxc-project#15495) (sapphi-red)
- 7d1ebad isolated-declarations: Incorrect nested namespace output in
isolated declarations (oxc-project#15800) (copilot-swe-agent)

### ⚡ Performance

- b4b0ed8 transformer/typescript: Reverse order of checks (oxc-project#15722)
(overlookmotel)

### 📚 Documentation

- c81a331 data_structures: Doc comments on fields of `Stack` (oxc-project#15793)
(overlookmotel)
- cfae31d allocator: Use `allocator` as var name in examples (oxc-project#15781)
(overlookmotel)

Co-authored-by: Boshen <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

C-docs Category - Documentation. Related to user-facing or internal documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant