Skip to content

Commit a3f66e6

Browse files
Remove all @doc mentions (#444)
* Remove all @doc mentions * fix parsefile! docs reference
1 parent cb4b7cd commit a3f66e6

3 files changed

Lines changed: 7 additions & 4 deletions

File tree

src/JSON.jl

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -107,7 +107,9 @@ end
107107
# convenience aliases for pre-1.0 JSON compat
108108
print(io::IO, obj, indent=nothing) = json(io, obj; pretty=something(indent, 0))
109109
print(a, indent=nothing) = print(stdout, a, indent)
110-
@doc (@doc json) print
110+
111+
"See [`json`](@ref)."
112+
print
111113

112114
@compile_workload begin
113115
x = JSON.parse("{\"a\": 1, \"b\": null, \"c\": true, \"d\": false, \"e\": \"\", \"f\": [1,null,true], \"g\": {\"key\": \"value\"}}")

src/lazy.jl

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -87,7 +87,8 @@ lazy(io::Union{IO, Base.AbstractCmd}; kw...) = lazy(Base.read(io); kw...)
8787

8888
lazyfile(file; jsonlines::Union{Bool, Nothing}=nothing, kw...) = open(io -> lazy(io; jsonlines=(jsonlines === nothing ? isjsonl(file) : jsonlines), kw...), file)
8989

90-
@doc (@doc lazy) lazyfile
90+
"See [`lazy`](@ref)."
91+
lazyfile
9192

9293
function lazy(buf::Union{AbstractVector{UInt8}, AbstractString}; isroot::Bool=true, kw...)
9394
if !applicable(pointer, buf, 1) || (buf isa AbstractVector{UInt8} && !isone(only(strides(buf))))

src/parse.jl

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -165,11 +165,11 @@ nullvalue(st::JSONReadStyle) = st.null
165165
# this allows struct fields to specify tags under the json key specifically to override JSON behavior
166166
StructUtils.fieldtagkey(::JSONStyle) = :json
167167

168+
"See [`parse`](@ref)."
168169
function parsefile end
169-
@doc (@doc parse) parsefile
170170

171+
"See [`parse`](@ref)."
171172
function parsefile! end
172-
@doc (@doc parse) parsefile!
173173

174174
parsefile(file; jsonlines::Union{Bool,Nothing}=nothing, kw...) = open(io -> parse(io; jsonlines=(jsonlines === nothing ? isjsonl(file) : jsonlines), kw...), file)
175175
parsefile(file, ::Type{T}; jsonlines::Union{Bool,Nothing}=nothing, kw...) where {T} = open(io -> parse(io, T; jsonlines=(jsonlines === nothing ? isjsonl(file) : jsonlines), kw...), file)

0 commit comments

Comments
 (0)