Skip to content

Wrap long code lines in guide documentation #491

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
ocots merged 3 commits into from
Jul 11, 2026
Merged

Wrap long code lines in guide documentation #491

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
ac0d5ed
Wrap long code lines in guide documentation
ocots Jul 11, 2026
349b420
Add Base.show methods for Plotting IR types
ocots Jul 11, 2026
e8c2889
docs: add setup block to plotting guide to suppress image output in e…
ocots Jul 11, 2026
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
10 changes: 8 additions & 2 deletions docs/src/guide/api-documentation.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -160,7 +160,12 @@ CTBase.automatic_reference_documentation(;
public=true,
private=false,
public_title="User API",
public_description="This page documents the public interface for end users. All functions listed here are stable and safe to use in your applications.",
public_description="""
This page documents the public interface
for end users. All functions listed here
are stable and safe to use in your
applications.
""",
filename="api",
)
```
Expand Down Expand Up @@ -436,7 +441,8 @@ jobs:
- uses: actions/checkout@v2
- uses: julia-actions/setup-julia@v1
- name: Install dependencies
run: julia --project=docs -e 'using Pkg; Pkg.develop(PackageSpec(path=pwd())); Pkg.instantiate()'
run: |
julia --project=docs -e 'using Pkg; Pkg.develop(PackageSpec(path=pwd())); Pkg.instantiate()'
- name: Build documentation
run: julia --project=docs docs/make.jl
- name: Deploy to GitHub Pages
Expand Down
9 changes: 6 additions & 3 deletions docs/src/guide/color-system.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -227,8 +227,11 @@ This ensures your display code:
## See Also

- [`Core.Style`](@ref), [`Core.Palette`](@ref) — type definitions
- [`Core.DEFAULT_PALETTE`](@ref), [`Core.MONOCHROME_PALETTE`](@ref), [`Core.HIGH_CONTRAST_PALETTE`](@ref) — built-in themes
- [`Core.current_palette`](@ref), [`Core.set_palette!`](@ref), [`Core.reset_palette!`](@ref) — palette switching
- [`Core.DEFAULT_PALETTE`](@ref), [`Core.MONOCHROME_PALETTE`](@ref),
[`Core.HIGH_CONTRAST_PALETTE`](@ref) — built-in themes
- [`Core.current_palette`](@ref), [`Core.set_palette!`](@ref),
[`Core.reset_palette!`](@ref) — palette switching
- [`Core.set_color!`](@ref) — single-role override
- [`Core.get_format_codes`](@ref) — derive styled codes for custom `show` methods
- [`Core.get_format_codes`](@ref) — derive styled codes for
custom `show` methods
- [`Core.show_palette`](@ref) — interactive preview of the active palette
4 changes: 2 additions & 2 deletions docs/src/guide/coverage.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,8 +27,8 @@ To generate actionable coverage reports, we use a dedicated `coverage.jl` script
### Example `test/coverage.jl`

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

using Pkg
Expand Down
Loading