Skip to content

some improvements to [shapes.md] #74

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.

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

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open

Conversation

Mo-Gul
Copy link

@Mo-Gul Mo-Gul commented Mar 9, 2025

Feel free to cherry-pick.

(Other) Remarks:

  • Julia is the only (open source) language where no output (i.e. the plots) are shown. Is that intended?

  • I can't build the docs locally with Julia 1.11.3. Using the given Manifest.toml I receive various precompilation errors. Updating first to most recent packages and running make html I get various

    Warning: failed when running filled-area-plots.md
    Error is:
    ErrorException("Could not parse yaml frontmatter. Make sure it is separated by ---")

    errors. (Maybe this is related to the previous point.)

  • missing links (to other parts of the docs)

    _Note:_ there are [special methods `add_hline`, `add_vline`, `add_hrect` and `add_vrect` for the common cases of wanting to draw horizontal or vertical lines or rectangles] that are fixed to data coordinates in one axis and absolutely positioned in another.

    This shape-drawing feature is particularly interesting for annotating graphs, in particular [image traces] or [layout images](/julia/images).

  • (at least) the commands add_hline!, add_vline!, add_hrect! and add_vrect! aren't found when I search for them in the manual.
    I'd say at least every command should have a corresponding manual entry and should be findable by the search function.

  • Is it intended that 6 values of x|yref are given as chars, e.g. 'x' instead of as strings?

  • I suspect that in

    attr(type="rect", xref="x2", yref="y4",

    the "y4" should be a "y2", right? If this is intended, I suggest to add a comment to the code.

Mo-Gul added 2 commits March 9, 2025 15:14
so `add_...!` can be used without that an error is thrown (see <sglyon/PlotlyBase.jl#99>).
Remaining is `path()` which doesn't work or exist (see <sglyon/PlotlyBase.jl#116>)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant