Skip to content
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

[WIP] Enhance attribute docs #334

Draft
wants to merge 12 commits into
base: master
Choose a base branch
from

Conversation

Ininterrompue
Copy link
Contributor

@Ininterrompue Ininterrompue commented Dec 14, 2022

Reformats docstrings.

@BeastyBlacksmith BeastyBlacksmith marked this pull request as draft December 14, 2022 08:07
@Ininterrompue Ininterrompue marked this pull request as ready for review December 14, 2022 23:17
@BeastyBlacksmith
Copy link
Member

BeastyBlacksmith commented Dec 15, 2022

That is a good first step in that we now have a clear vision what the output should look like, but in order to not have to update this once we change something in Plots we need to generate these pages from the information in Plots.

For example you can generate a simple mardown document like this:

using Markdown
a = 2
md_doc = MD()
push!(md_doc, md"""
 # Header

`a` has the value $(a).
""")
open("test.md", write = true) do io
     print(io, md_doc)
end

@t-bltg
Copy link
Member

t-bltg commented Dec 15, 2022

Yeah, otherwise this will be a nightmare for maintainability.
These pages have to be auto-generated.

@Ininterrompue
Copy link
Contributor Author

What would be the cleanest way to make sure there are sections for Subplot and Axis attributes, e.g. annotation, colorbar, etc. so that they show up on the dropdown menu, like how it's done in the commit beforehand? That's an important thing that needs to be done imo. Wouldn't those changes have to be made in Plots.jl since it would be beneficial to be able to do plotattr(:Annotation) in the REPL to print all annotation subplot attributes?

@t-bltg
Copy link
Member

t-bltg commented Dec 15, 2022

I have no idea what the final solution would look like but changes can be made in Plots to accompany this PR. Clarity and concision should be preferred.

@Ininterrompue
Copy link
Contributor Author

See relevant PR

@t-bltg
Copy link
Member

t-bltg commented Feb 9, 2023

@Ininterrompue, could you post screenshots (after a local docs build against this PR) of what this would look like ?

It's a bit hard to approve without having an overview of the final result ...

@BeastyBlacksmith BeastyBlacksmith marked this pull request as draft February 9, 2023 12:32
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.

3 participants