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.

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

Jump to bottom

no explanation for arguments in plotconfig #106

Closed
vladdez opened this issue Nov 16, 2023 · 7 comments
Closed

no explanation for arguments in plotconfig #106

vladdez opened this issue Nov 16, 2023 · 7 comments
Labels
documentation Improvements or additions to documentation

Comments

@vladdez
Copy link
Collaborator

vladdez commented Nov 16, 2023

The arguments which come up in the fields Shared Configuration Options - their functionality is not explained anywhere (not even in docs). It should be definitely explained in docstrings.
@behinger
Copy link
Member

can you provide more information on what you mean? I cannot find "shared configuration options" anywhere

@vladdez
Copy link
Collaborator Author

vladdez commented Nov 16, 2023 •
edited
Loading

image
Imagine I would like to used plot_designmatrix()
But I can not find anywhere a docstring or documentation page about arguments from Shared plot configuration option.
For instance, xlabelFromMapping (actaully what does it?).

@behinger
Copy link
Member

ah I see. So you are missing documentation for the subfields of the shared options.

Yeah, we can create one and link it - putting them in each functions docstring probably too much. But we could put them in e.g. ?plotconfig or something

@vladdez
Copy link
Collaborator Author

vladdez commented Nov 16, 2023

Yep! How it will works then?

@behinger
Copy link
Member

you could provide documentation in the docstring of PlotConfig - or maybe better use something lke

"""
- X => Bla
- Y => Blub
"""
configoptions() = "the docstring to this function reveals documentation to all options pre-specified via in PlotConfig"

@vladdez vladdez added the documentation Improvements or additions to documentation label Mar 25, 2024
@vladdez
Copy link
Collaborator Author

vladdez commented Sep 17, 2024 •
edited
Loading

Conclusion:

  • - write to mapping - "Use any mapping from AOG"
  • - deprecate show_legend where it is unnecessary
  • - check that all lines have links

@vladdez vladdez closed this as completed Sep 23, 2024
@vladdez
Copy link
Collaborator Author

vladdez commented Sep 23, 2024

#237

@vladdez vladdez mentioned this issue Sep 23, 2024
Merged
vladdez added a commit that referenced this issue Sep 24, 2024
@vladdez
Merge pull request #237 from unfoldtoolbox/splines
b805907 
Splines and plot_erp

Fixed:
- #231 
- #235
- #225 - this parameter was deprecated at all
- #234 
- remove `legend.tellwidth = false` from the plotconfgs - better layout
- #55 and #238
- #216
- #56
- #232
- #172 
- #222
- #236 
- #205 
- partially #94 
- #106 
- #183 
- #141 
- #147 

Spline plot 
- #36 - here we added a new type of plot plot_splines
- knots with dashed line
- subplots for each spline term
- documentation page and config

Also
- system of supportive axis available for users to change
- opportunity to put them into docstrings via substitution
@vladdez vladdez mentioned this issue Sep 24, 2024
Open
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
documentation Improvements or additions to documentation
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@behinger @vladdez