Skip to content

Commit fb6aedf

Browse files
authored
Merge pull request #491 from control-toolbox/docs/wrap-long-code-lines
Wrap long code lines in guide documentation
2 parents 49076c9 + e8c2889 commit fb6aedf

17 files changed

Lines changed: 1202 additions & 199 deletions

docs/src/guide/api-documentation.md

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -160,7 +160,12 @@ CTBase.automatic_reference_documentation(;
160160
public=true,
161161
private=false,
162162
public_title="User API",
163-
public_description="This page documents the public interface for end users. All functions listed here are stable and safe to use in your applications.",
163+
public_description="""
164+
This page documents the public interface
165+
for end users. All functions listed here
166+
are stable and safe to use in your
167+
applications.
168+
""",
164169
filename="api",
165170
)
166171
```
@@ -436,7 +441,8 @@ jobs:
436441
- uses: actions/checkout@v2
437442
- uses: julia-actions/setup-julia@v1
438443
- name: Install dependencies
439-
run: julia --project=docs -e 'using Pkg; Pkg.develop(PackageSpec(path=pwd())); Pkg.instantiate()'
444+
run: |
445+
julia --project=docs -e 'using Pkg; Pkg.develop(PackageSpec(path=pwd())); Pkg.instantiate()'
440446
- name: Build documentation
441447
run: julia --project=docs docs/make.jl
442448
- name: Deploy to GitHub Pages

docs/src/guide/color-system.md

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -227,8 +227,11 @@ This ensures your display code:
227227
## See Also
228228

229229
- [`Core.Style`](@ref), [`Core.Palette`](@ref) — type definitions
230-
- [`Core.DEFAULT_PALETTE`](@ref), [`Core.MONOCHROME_PALETTE`](@ref), [`Core.HIGH_CONTRAST_PALETTE`](@ref) — built-in themes
231-
- [`Core.current_palette`](@ref), [`Core.set_palette!`](@ref), [`Core.reset_palette!`](@ref) — palette switching
230+
- [`Core.DEFAULT_PALETTE`](@ref), [`Core.MONOCHROME_PALETTE`](@ref),
231+
[`Core.HIGH_CONTRAST_PALETTE`](@ref) — built-in themes
232+
- [`Core.current_palette`](@ref), [`Core.set_palette!`](@ref),
233+
[`Core.reset_palette!`](@ref) — palette switching
232234
- [`Core.set_color!`](@ref) — single-role override
233-
- [`Core.get_format_codes`](@ref) — derive styled codes for custom `show` methods
235+
- [`Core.get_format_codes`](@ref) — derive styled codes for
236+
custom `show` methods
234237
- [`Core.show_palette`](@ref) — interactive preview of the active palette

docs/src/guide/coverage.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -27,8 +27,8 @@ To generate actionable coverage reports, we use a dedicated `coverage.jl` script
2727
### Example `test/coverage.jl`
2828

2929
```julia
30-
# Add the test directory to the load path so Julia can find dependencies from
31-
# test/Project.toml.
30+
# Add the test directory to the load path so Julia
31+
# can find dependencies from test/Project.toml.
3232
pushfirst!(LOAD_PATH, @__DIR__)
3333

3434
using Pkg

0 commit comments

Comments
 (0)