Skip to content

Commit

Permalink
Docs: update api.md
Browse files Browse the repository at this point in the history
  • Loading branch information
@sefffal
sefffal committed Dec 17, 2024
1 parent 30b14ce commit a33a70d
Showing 1 changed file with 3 additions and 2 deletions.
5 changes: 3 additions & 2 deletions docs/src/api.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -12,11 +12,12 @@ PairPlots.VizTypeDiag
PairPlots.HexBin
PairPlots.Hist
PairPlots.Calculation
PairPlots.Correlation
PairPlots.PearsonCorrelation
PairPlots.Contour
PairPlots.Contourf
PairPlots.Scatter
PairPlots.MarginConfidenceLimits
PairPlots.MarginQuantileText
PairPlots.MarginQuantileLines
PairPlots.MarginHist
PairPlots.MarginStepHist
PairPlots.MarginDensity
Expand Down

2 comments on commit a33a70d

@sefffal
Copy link
Owner Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@JuliaRegistrator register

Breaking changes

  • Requires Julia 1.10 (previously, 1.7), Makie 0.21.18+
  • Renames the alias PairPlots.Correlation() to PairPlots.PearsonCorrelation()
  • Adds PairPlots.MarginQuantileText()
  • Removes PairPlots.MarginConfidenceLimits(), in favour of PairPlots.MarginQuantileText() and PairPlots.MarginQuantileLines()

@JuliaRegistrator
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Registration pull request created: JuliaRegistries/General/121566

Tip: Release Notes

Did you know you can add release notes too? Just add markdown formatted text underneath the comment after the text
"Release notes:" and it will be added to the registry PR, and if TagBot is installed it will also be added to the
release that TagBot creates. i.e.

@JuliaRegistrator register

Release notes:

## Breaking changes

- blah

To add them here just re-invoke and the PR will be updated.

Tagging

After the above pull request is merged, it is recommended that a tag is created on this repository for the registered package version.

This will be done automatically if the Julia TagBot GitHub Action is installed, or can be done manually through the github interface, or via:

git tag -a v3.0.0 -m "<description of version>" a33a70d9fad97049a37d56f710157a67626f1e3c
git push origin v3.0.0

Please sign in to comment.