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

Added doc on Makie package extension #3646

Merged
merged 1 commit into from
Feb 22, 2024
Merged

Conversation

kapple19
Copy link
Contributor

@kapple19 kapple19 commented Feb 21, 2024

Description

Fixes lack of documentation on adding a package extension for Makie.

Type of change

Appended package extension implementation guide to recipes.md.

Checklist

  • Added an entry in CHANGELOG.md (for new features and breaking changes)
  • Added or changed relevant sections in the documentation
  • Added unit tests for new algorithms, conversion methods, etc.
  • Added reference image tests for new plotting functions, recipes, visual options, etc.

@kapple19
Copy link
Contributor Author

@jkrumbiegel I'm not sure if you preferred I don't link to your example.
If not, let me know and I can remove the link,
but also add more of the example from your code into the documentation here.

Also let me know if you'd like more details or to actually add an example.

@jkrumbiegel
Copy link
Member

What I had been thinking about was to add an extension test to our test suite, and this would double as an example to point people to. Being a test, it would not go out of sync and we could be sure that our intended extension mechanism keeps working in future julia versions.

@SimonDanisch
Copy link
Member

@kapple19 can you add a changelog entry? :)
https://github.com/MakieOrg/Makie.jl/blob/master/CHANGELOG.md

@jkrumbiegel
Copy link
Member

@SimonDanisch I would say a docs change doesn't need one, I'll use the skip label here

@jkrumbiegel jkrumbiegel added the skip-changelog Skips changelog enforcer label Feb 22, 2024
@SimonDanisch SimonDanisch merged commit dfe6eab into MakieOrg:master Feb 22, 2024
2 of 3 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
skip-changelog Skips changelog enforcer
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants