Skip to content

docs(linter/plugins): correct comment about offset to line-column conversion#20506

Merged
graphite-app[bot] merged 1 commit intomainfrom
om/03-18-docs_linter_plugins_correct_comment_about_offset_to_line-column_conversion
Mar 21, 2026
Merged

docs(linter/plugins): correct comment about offset to line-column conversion#20506
graphite-app[bot] merged 1 commit intomainfrom
om/03-18-docs_linter_plugins_correct_comment_about_offset_to_line-column_conversion

Conversation

@overlookmotel
Copy link
Member

@overlookmotel overlookmotel commented Mar 18, 2026

Correct a comment. It didn't accurately describe what the code does.

Copy link
Member Author

overlookmotel commented Mar 18, 2026


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 changes, fast-track this PR to the front of the merge queue

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.

@overlookmotel overlookmotel marked this pull request as ready for review March 18, 2026 21:57
@overlookmotel overlookmotel requested a review from camc314 as a code owner March 18, 2026 21:57
Copilot AI review requested due to automatic review settings March 18, 2026 21:57
@overlookmotel overlookmotel self-assigned this Mar 18, 2026
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 corrects documentation in the location plugin to accurately describe how offsets are converted to (line, column) using the lineStartIndices table. This improves maintainability and reduces the chance of future mistakes when modifying the binary search logic.

Changes:

  • Update the comment in populateLineColumn to describe the “upper_bound” style binary search and its post-conditions.
  • Add clarifying inline comments that out.line is 1-indexed and out.column is relative to the start of the computed line.

@overlookmotel overlookmotel force-pushed the om/03-18-docs_linter_plugins_correct_comment_about_offset_to_line-column_conversion branch from e2ae309 to f3c82c6 Compare March 18, 2026 22:35
@graphite-app graphite-app bot added the 0-merge Merge with Graphite Merge Queue label Mar 20, 2026
@overlookmotel overlookmotel removed the 0-merge Merge with Graphite Merge Queue label Mar 20, 2026
@overlookmotel overlookmotel added the 0-merge Merge with Graphite Merge Queue label Mar 20, 2026 — with Graphite App
@overlookmotel overlookmotel force-pushed the om/03-18-docs_linter_plugins_correct_comment_about_offset_to_line-column_conversion branch from f3c82c6 to f5c738d Compare March 21, 2026 12:21
@overlookmotel overlookmotel force-pushed the om/03-18-perf_linter_plugins_reuse_descriptor_objects_for_object.defineproperty_calls branch from 33b0950 to 982be40 Compare March 21, 2026 12:21
@overlookmotel overlookmotel changed the base branch from om/03-18-perf_linter_plugins_reuse_descriptor_objects_for_object.defineproperty_calls to graphite-base/20506 March 21, 2026 12:32
@overlookmotel overlookmotel force-pushed the om/03-18-docs_linter_plugins_correct_comment_about_offset_to_line-column_conversion branch from f5c738d to 897dc88 Compare March 21, 2026 12:33
@overlookmotel overlookmotel changed the base branch from graphite-base/20506 to om/03-18-perf_linter_plugins_reuse_descriptor_objects_for_object.defineproperty_calls March 21, 2026 12:33
@graphite-app graphite-app bot force-pushed the om/03-18-perf_linter_plugins_reuse_descriptor_objects_for_object.defineproperty_calls branch 2 times, most recently from 44e3182 to cf6e31d Compare March 21, 2026 12:53
@graphite-app graphite-app bot force-pushed the om/03-18-docs_linter_plugins_correct_comment_about_offset_to_line-column_conversion branch from 897dc88 to bfa3661 Compare March 21, 2026 12:54
@graphite-app graphite-app bot changed the base branch from om/03-18-perf_linter_plugins_reuse_descriptor_objects_for_object.defineproperty_calls to graphite-base/20506 March 21, 2026 12:57
@graphite-app
Copy link
Contributor

graphite-app bot commented Mar 21, 2026

Merge activity

@graphite-app graphite-app bot changed the base branch from graphite-base/20506 to main March 21, 2026 13:01
…version (#20506)

Correct a comment. It didn't accurately describe what the code does.
@graphite-app graphite-app bot force-pushed the om/03-18-docs_linter_plugins_correct_comment_about_offset_to_line-column_conversion branch from bfa3661 to f064f80 Compare March 21, 2026 13:02
@graphite-app graphite-app bot merged commit f064f80 into main Mar 21, 2026
23 checks passed
@graphite-app graphite-app bot removed the 0-merge Merge with Graphite Merge Queue label Mar 21, 2026
@graphite-app graphite-app bot deleted the om/03-18-docs_linter_plugins_correct_comment_about_offset_to_line-column_conversion branch March 21, 2026 13:05
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

A-cli Area - CLI A-linter Area - Linter A-linter-plugins Area - Linter JS plugins C-docs Category - Documentation. Related to user-facing or internal documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants