Skip to content

Add 'See also' sections to regex function docstring #59744

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Add 'See also' sections to regex function docstring #59744

wants to merge 1 commit into from
+15 −0

Conversation

GianmarcoCuppari
Copy link

Fixes #56752

Added "See also" sections to the following regex function docstrings:
- `match`: links to eachmatch, occursin, findfirst
- `eachmatch`: links to match, findall, count
- `count`: links to eachmatch, occursin, findall
- `startswith`: links to endswith, occursin, match
- `endswith`: links to startswith, occursin, match

@GianmarcoCuppari
Add 'See also' sections to regex function docstring
064b281 
- Add cross-references between match, eachmatch, count
- Add cross-references between startswith and endswith
- Link related functions like occursin, findfirst, findall
- Addresses JuliaLang#56752
@GianmarcoCuppari GianmarcoCuppari mentioned this pull request Oct 4, 2025
Open
@LilithHafner LilithHafner added the docs This change adds or pertains to documentation label Oct 5, 2025
@LilithHafner
Copy link
Member

Thanks!

LilithHafner
LilithHafner reviewed Oct 5, 2025
View reviewed changes
Copy link
Member

@LilithHafner LilithHafner left a comment

Choose a reason for hiding this comment

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

One minor change and then LGTM!

base/regex.jl
```
# See also
[`endswith`](@ref), [`occursin`](@ref), [`match`](@ref)
Copy link
Member

Choose a reason for hiding this comment

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

Adding match is a good idea, though it just needs to be added to the existing see also section above.

Same for the endswith docstring below

@LilithHafner LilithHafner assigned LilithHafner and unassigned vtjnash Oct 5, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@LilithHafner LilithHafner LilithHafner left review comments

Assignees

@LilithHafner LilithHafner

Labels
docs This change adds or pertains to documentation
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Add "See also" to the regex function docstrings
3 participants
@GianmarcoCuppari @LilithHafner @vtjnash