Skip to content

Fix docs spanned source text#5268

Open
Chaitanya-Parab wants to merge 2 commits intoboa-dev:mainfrom
Chaitanya-Parab:fix-docs-spanned-source-text
Open

Fix docs spanned source text#5268
Chaitanya-Parab wants to merge 2 commits intoboa-dev:mainfrom
Chaitanya-Parab:fix-docs-spanned-source-text

Conversation

@Chaitanya-Parab
Copy link
Copy Markdown

This Pull Request fixes/closes #{4524}.

It changes the following:

  • Fixes incorrect documentation for SpannedSourceText::is_empty
  • Removes misleading comments that described unrelated functionality (likely a copy-paste error)
  • Adds accurate documentation reflecting the actual behavior of the function

@Chaitanya-Parab Chaitanya-Parab requested a review from a team as a code owner March 27, 2026 13:27
@github-actions github-actions bot added C-Documentation update documentation Waiting On Review Waiting on reviews from the maintainers labels Mar 27, 2026
@github-actions github-actions bot added this to the v1.0.0 milestone Mar 27, 2026
Comment on lines +33 to +39
/// Creates a new `SpannedSourceText` from the given source string.
///
/// # Arguments
/// - `source`: The source text to wrap.
///
/// # Returns
/// A new `SpannedSourceText` instance.
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

this does not match with the actual function?

Comment on lines +83 to +86
/// Returns `true` if the span or the source text is empty.
///
/// # Returns
/// `true` if there is no span or the underlying source text is empty, otherwise `false`.
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

the original comment is much more concise

Comment thread docs/idea_apiaudit.md
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

unrelated

@Chaitanya-Parab
Copy link
Copy Markdown
Author

ok I will do check it out

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

C-Documentation update documentation Waiting On Review Waiting on reviews from the maintainers

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants