test: add reference outputs

ReubenJ · ReubenJ · commit 62479ea8f439 · 2025-11-23T19:24:00.000+01:00
diff --git a/test/reference_outputs/fields.txt b/test/reference_outputs/fields.txt
@@ -0,0 +1,8 @@
+
+  - `a`: one
+
+  - `b`: two
+
+  - `c`
+
+
diff --git a/test/reference_outputs/function_names.txt b/test/reference_outputs/function_names.txt
@@ -0,0 +1 @@
+f
diff --git a/test/reference_outputs/license.txt b/test/reference_outputs/license.txt
@@ -0,0 +1,22 @@
+The DocStringExtensions.jl package is licensed under the MIT "Expat" License:
+
+> Copyright (c) 2016: Michael Hatherly.
+> 
+> Permission is hereby granted, free of charge, to any person obtaining a copy
+> of this software and associated documentation files (the "Software"), to deal
+> in the Software without restriction, including without limitation the rights
+> to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+> copies of the Software, and to permit persons to whom the Software is
+> furnished to do so, subject to the following conditions:
+> 
+> The above copyright notice and this permission notice shall be included in all
+> copies or substantial portions of the Software.
+> 
+> THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+> IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+> FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+> AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+> LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+> OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+> SOFTWARE.
+> 
diff --git a/test/reference_outputs/method_lists.txt b/test/reference_outputs/method_lists.txt
@@ -0,0 +1,8 @@
+
+```julia
+f(x)
+```
+
+defined at [`[...]DocStringExtensions.jl/test/TestModule/M.jl:5`](https://github.com/JuliaDocs/NonExistent.jl/tree/[...]/M.jl#L5).
+
+
diff --git a/test/reference_outputs/method_signatures.txt b/test/reference_outputs/method_signatures.txt
@@ -0,0 +1,6 @@
+
+```julia
+f(x)
+
+```
+
diff --git a/test/reference_outputs/module_exports.txt b/test/reference_outputs/module_exports.txt
@@ -0,0 +1,3 @@
+
+  - [`f`](@ref)
+
diff --git a/test/reference_outputs/module_imports_pre_112.txt b/test/reference_outputs/module_imports_pre_112.txt
@@ -0,0 +1,4 @@
+
+  - `Base`
+  - `Core`
+
diff --git a/test/reference_outputs/readme.txt b/test/reference_outputs/readme.txt
@@ -0,0 +1,46 @@
+# DocStringExtensions
+
+*Extensions for Julia's docsystem.*
+
+| **Documentation**                                                               | **Build Status**                                                                                |
+|:-------------------------------------------------------------------------------:|:-----------------------------------------------------------------------------------------------:|
+| [![][docs-stable-img]][docs-stable-url] [![][docs-latest-img]][docs-latest-url] | [![CI][github-action-img]][github-action-url] [![][codecov-img]][codecov-url] |
+
+## Installation
+
+The package can be added using the Julia package manager. From the Julia REPL, type `]`
+to enter the Pkg REPL mode and run
+
+```
+pkg> add DocStringExtensions
+```
+
+## Documentation
+
+- [**STABLE**][docs-stable-url] &mdash; **most recently tagged version of the documentation.**
+- [**LATEST**][docs-latest-url] &mdash; *in-development version of the documentation.*
+
+## Project Status
+
+The package is tested and developed against Julia `1.0`, as well as the latest `stable` and `nightly` versions on Linux, OS X, and Windows,
+but there are versions of the package that work on older versions of Julia.
+
+## Contributing and Questions
+
+Contributions are very welcome, as are feature requests and suggestions. Please open an [issue][issues-url] if you encounter any problems. If you have a question then feel free to ask for help in the [Gitter chat room][gitter-url].
+
+[gitter-url]: https://gitter.im/juliadocs/users
+
+[docs-latest-img]: https://img.shields.io/badge/docs-latest-blue.svg
+[docs-latest-url]: https://DocStringExtensions.juliadocs.org/latest
+
+[docs-stable-img]: https://img.shields.io/badge/docs-stable-blue.svg
+[docs-stable-url]: https://DocStringExtensions.juliadocs.org/stable
+
+[github-action-img]: https://github.com/JuliaDocs/DocStringExtensions.jl/actions/workflows/ci.yml/badge.svg
+[github-action-url]: https://github.com/JuliaDocs/DocStringExtensions.jl/actions/workflows/ci.yml
+
+[codecov-img]: https://codecov.io/gh/JuliaDocs/DocStringExtensions.jl/branch/master/graph/badge.svg
+[codecov-url]: https://codecov.io/gh/JuliaDocs/DocStringExtensions.jl
+
+[issues-url]: https://github.com/JuliaDocs/DocStringExtensions.jl/issues
diff --git a/test/reference_outputs/signatures_110_and_later.txt b/test/reference_outputs/signatures_110_and_later.txt
@@ -0,0 +1,7 @@
+
+```julia
+g(; ...)
+g(x; ...)
+
+```
+
diff --git a/test/reference_outputs/signatures_many_tuples_110_and_later.txt b/test/reference_outputs/signatures_many_tuples_110_and_later.txt
@@ -0,0 +1,9 @@
+
+```julia
+g(; ...)
+g(x; ...)
+g(x, y; ...)
+g(x, y, z; kwargs...)
+
+```
+
diff --git a/test/reference_outputs/signatures_tuple_any.txt b/test/reference_outputs/signatures_tuple_any.txt
@@ -0,0 +1,6 @@
+
+```julia
+g_1(x)
+
+```
+
diff --git a/test/reference_outputs/signatures_union_tuple_int_any.txt b/test/reference_outputs/signatures_union_tuple_int_any.txt
@@ -0,0 +1,6 @@
+
+```julia
+h_4(x, _, z)
+
+```
+
diff --git a/test/reference_outputs/typed_fields.txt b/test/reference_outputs/typed_fields.txt
@@ -0,0 +1,8 @@
+
+  - `a::Any`: one
+
+  - `b::Any`: two
+
+  - `c::Any`
+
+
diff --git a/test/reference_outputs/typed_method_signatures_64bit.txt b/test/reference_outputs/typed_method_signatures_64bit.txt
@@ -0,0 +1,6 @@
+
+```julia
+h(x::Int64, y::Int64, z::Int64; kwargs...) -> Int64
+
+```
+
diff --git a/test/reference_outputs/typed_method_signatures_64bit_110_and_later.txt b/test/reference_outputs/typed_method_signatures_64bit_110_and_later.txt
@@ -0,0 +1,6 @@
+
+```julia
+h(x::Int64; ...) -> Int64
+
+```
+
diff --git a/test/reference_outputs/typed_method_signatures_k0.txt b/test/reference_outputs/typed_method_signatures_k0.txt
@@ -0,0 +1,6 @@
+
+```julia
+k_0(x) -> Any
+
+```
+
diff --git a/test/reference_outputs/typed_method_signatures_k1.txt b/test/reference_outputs/typed_method_signatures_k1.txt
@@ -0,0 +1,8 @@
+
+```julia
+k_1(x::String) -> String
+k_1(x::String, y::Number) -> String
+k_1(x::String, y::Number, z::Number) -> String
+
+```
+
diff --git a/test/reference_outputs/typed_method_signatures_k11.txt b/test/reference_outputs/typed_method_signatures_k11.txt
@@ -0,0 +1,6 @@
+
+```julia
+k_11(x::Int64, xs...) -> Int64
+
+```
+
diff --git a/test/reference_outputs/typed_method_signatures_k12.txt b/test/reference_outputs/typed_method_signatures_k12.txt
@@ -0,0 +1,6 @@
+
+```julia
+k_12(x::Int64, xs::Real...) -> Int64
+
+```
+
diff --git a/test/reference_outputs/typed_method_signatures_k2.txt b/test/reference_outputs/typed_method_signatures_k2.txt
@@ -0,0 +1,6 @@
+
+```julia
+k_2(x::String, y::Complex, z::Number) -> String
+
+```
+
diff --git a/test/reference_outputs/typed_method_signatures_k3.txt b/test/reference_outputs/typed_method_signatures_k3.txt
@@ -0,0 +1,6 @@
+
+```julia
+k_3(x, y, z) -> Any
+
+```
+
diff --git a/test/reference_outputs/typed_method_signatures_k4_post_13_64bit.txt b/test/reference_outputs/typed_method_signatures_k4_post_13_64bit.txt
@@ -0,0 +1,7 @@
+
+```julia
+k_4(::String)
+k_4(::String, ::Int64)
+
+```
+
diff --git a/test/reference_outputs/typed_method_signatures_k5_post_13.txt b/test/reference_outputs/typed_method_signatures_k5_post_13.txt
@@ -0,0 +1,11 @@
+
+```julia
+k_5(::Type{T<:Number}, x::String) -> String
+k_5(
+    ::Type{T<:Number},
+    x::String,
+    func::Union{Nothing, Function}
+) -> String
+
+```
+
diff --git a/test/reference_outputs/typed_method_signatures_k6_16_and_later.txt b/test/reference_outputs/typed_method_signatures_k6_16_and_later.txt
@@ -0,0 +1,6 @@
+
+```julia
+k_6(x::Array{T<:Number, 1}) -> Vector{T} where T<:Number
+
+```
+
diff --git a/test/reference_outputs/typed_method_signatures_k7_not_16.txt b/test/reference_outputs/typed_method_signatures_k7_not_16.txt
@@ -0,0 +1,12 @@
+
+```julia
+k_7(
+    x::Union{Nothing, T} where T<:Integer
+) -> Union{Nothing, T} where T<:Integer
+k_7(
+    x::Union{Nothing, T} where T<:Integer,
+    y::Integer
+) -> Union{Nothing, T} where T<:Integer
+
+```
+
diff --git a/test/reference_outputs/typed_method_signatures_k8.txt b/test/reference_outputs/typed_method_signatures_k8.txt
@@ -0,0 +1,6 @@
+
+```julia
+k_8(x) -> Any
+
+```
+
diff --git a/test/reference_outputs/typed_method_signatures_k9.txt b/test/reference_outputs/typed_method_signatures_k9.txt
@@ -0,0 +1,6 @@
+
+```julia
+k_9(x) -> Any
+
+```
+
diff --git a/test/reference_outputs/typed_method_signatures_tuple_string.txt b/test/reference_outputs/typed_method_signatures_tuple_string.txt
@@ -0,0 +1,6 @@
+
+```julia
+g_2(x::String) -> Type{String}
+
+```
+
diff --git a/test/reference_outputs/typed_method_signatures_windows_18_and_later.txt b/test/reference_outputs/typed_method_signatures_windows_18_and_later.txt
@@ -0,0 +1,8 @@
+
+```julia
+h_1(
+    x::Union{Array{T, 3}, Array{T, 4}} where T
+) -> Union{Array{T, 3}, Array{T, 4}} where T
+
+```
+
diff --git a/test/reference_outputs/typedef1.txt b/test/reference_outputs/typedef1.txt
@@ -0,0 +1,5 @@
+
+```julia
+abstract type AbstractType1 <: Integer
+```
+
diff --git a/test/reference_outputs/typedef2.txt b/test/reference_outputs/typedef2.txt
@@ -0,0 +1,5 @@
+
+```julia
+abstract type AbstractType2{S, T<:Integer} <: Integer
+```
+
diff --git a/test/reference_outputs/typedef_bittype32.txt b/test/reference_outputs/typedef_bittype32.txt
@@ -0,0 +1,5 @@
+
+```julia
+primitive type BitType32 <: Real 32
+```
+
diff --git a/test/reference_outputs/typedef_bittype8.txt b/test/reference_outputs/typedef_bittype8.txt
@@ -0,0 +1,5 @@
+
+```julia
+primitive type BitType8 8
+```
+
diff --git a/test/reference_outputs/typedef_custom.txt b/test/reference_outputs/typedef_custom.txt
@@ -0,0 +1,5 @@
+
+```julia
+struct CustomType{S, T<:Integer} <: Integer
+```
+

-Original file line number
+Diff line change
@@ @@ -0,0 +1,8 @@ @@
++
 +  - `a`: one
++
 +  - `b`: two
++
 +  - `c`
++
++