Skip to content

Update annotated.jl docstrings according to #55741 #56736

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

Merged
merged 5 commits into from
Dec 3, 2024
Merged

Update annotated.jl docstrings according to #55741 #56736

Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
e24a84a
Update annotated.jl docstrings according to #55741
danielwe Dec 2, 2024
1b5fbd2
`julia-repl` -> `jldoctest`
danielwe Dec 2, 2024
609d00f
Fix doctests
danielwe Dec 2, 2024
d4a1b3e
Don't load StyledStrings in doctests
danielwe Dec 3, 2024
3f54330
fixup! Don't load StyledStrings in doctests
danielwe Dec 3, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 8 additions & 8 deletions base/strings/annotated.jl
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -55,9 +55,9 @@ like [`string`](@ref) but preserves any annotations present in the arguments.

# Examples

```julia-repl
```jldoctest; setup=:(using Base: AnnotatedString)
julia> AnnotatedString("this is an example annotated string",
[(1:18, :A => 1), (12:28, :B => 2), (18:35, :C => 3)])
[(1:18, :A, 1), (12:28, :B, 2), (18:35, :C, 3)])
"this is an example annotated string"
```
"""
Expand Down Expand Up @@ -87,8 +87,8 @@ AnnotatedChar(s::S, annotations::Vector{$Annotation})

# Examples

```julia-repl
julia> AnnotatedChar('j', :label => 1)
```jldoctest; setup=:(using Base: AnnotatedChar)
julia> AnnotatedChar('j', [(:label, 1)])
'j': ASCII/Unicode U+006A (category Ll: Letter, lowercase)
```
"""
Expand Down Expand Up @@ -232,11 +232,11 @@ See also [`AnnotatedString`](@ref) and [`AnnotatedChar`](@ref).

## Examples

```julia-repl
```jldoctest; setup=:(using Base: AnnotatedString, annotatedstring)
julia> annotatedstring("now a AnnotatedString")
"now a AnnotatedString"

julia> annotatedstring(AnnotatedString("annotated", [(1:9, :label => 1)]), ", and unannotated")
julia> annotatedstring(AnnotatedString("annotated", [(1:9, :label, 1)]), ", and unannotated")
"annotated, and unannotated"
```
"""
Expand Down Expand Up @@ -344,7 +344,7 @@ end
annotate!(str::AnnotatedString, [range::UnitRange{Int}], label::Symbol, value)
annotate!(str::SubString{AnnotatedString}, [range::UnitRange{Int}], label::Symbol, value)

Annotate a `range` of `str` (or the entire string) with a labeled value (`label` => `value`).
Annotate a `range` of `str` (or the entire string) with a labeled value `(label, value)`.
To remove existing `label` annotations, use a value of `nothing`.

The order in which annotations are applied to `str` is semantically meaningful,
Expand All @@ -365,7 +365,7 @@ annotate!(s::SubString{<:AnnotatedString}, label::Symbol, @nospecialize(val::Any
"""
annotate!(char::AnnotatedChar, label::Symbol, value::Any)

Annotate `char` with the pair `label => value`.
Annotate `char` with the labeled value `(label, value)`.
"""
annotate!(c::AnnotatedChar, label::Symbol, @nospecialize(val::Any)) =
(push!(c.annotations, Annotation((; label, val))); c)
Expand Down
Loading