Skip to content

Improve internal docs for various string-node APIs#16256

Merged
AlexWaygood merged 2 commits intomainfrom
alex/ast-docs
Feb 19, 2025
Merged

Improve internal docs for various string-node APIs#16256
AlexWaygood merged 2 commits intomainfrom
alex/ast-docs

Conversation

@AlexWaygood
Copy link
Copy Markdown
Member

Summary

A fairly minor PR touching up some internal docs, since I've been looking at these methods a lot recently

@AlexWaygood AlexWaygood added the internal An internal refactor or improvement label Feb 19, 2025
@github-actions
Copy link
Copy Markdown
Contributor

github-actions Bot commented Feb 19, 2025

ruff-ecosystem results

Linter (stable)

✅ ecosystem check detected no linter changes.

Linter (preview)

✅ ecosystem check detected no linter changes.

Formatter (stable)

✅ ecosystem check detected no format changes.

Formatter (preview)

✅ ecosystem check detected no format changes.

Copy link
Copy Markdown
Contributor

@ntBre ntBre left a comment

Choose a reason for hiding this comment

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

Nice, this looks great! The is_empty clarification seems especially helpful.

I actually slightly prefer the Returns an iterator phrasing, but I don't feel too strongly about it.

@AlexWaygood
Copy link
Copy Markdown
Member Author

I actually slightly prefer the Returns an iterator phrasing, but I don't feel too strongly about it.

Ah fair enough, I'll revert those changes!

@AlexWaygood AlexWaygood enabled auto-merge (squash) February 19, 2025 16:10
@AlexWaygood AlexWaygood merged commit 16d0625 into main Feb 19, 2025
@AlexWaygood AlexWaygood deleted the alex/ast-docs branch February 19, 2025 16:13
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

internal An internal refactor or improvement

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants