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

Inconsistent capitalisation of plot recipes names #3784

Open
owiecc opened this issue Apr 13, 2024 · 5 comments
Open

Inconsistent capitalisation of plot recipes names #3784

owiecc opened this issue Apr 13, 2024 · 5 comments
Labels
bug documentation Makie Backend independent issues (Makie core)

Comments

@owiecc
Copy link

owiecc commented Apr 13, 2024

Recipe names have inconsistent capitalisations. By convention Pascal case is used:

  • ABLines
  • BarPlot
  • DataShader
  • HLines
  • ScatterLines
  • StreamPlot

However, there are a few recipes that stray from this convention:

  • Voronoiplot
  • Tricontourf
  • Errorbars
@owiecc owiecc added the bug label Apr 13, 2024
@owiecc
Copy link
Author

owiecc commented Apr 13, 2024

This is pretty important for https://github.com/MakieOrg/AlgebraOfGraphics.jl where recipes are used instead of plotting functions.

@jkrumbiegel
Copy link
Member

I guess we could change their names and add and export const Voronoiplot = VoronoiPlot for backwards compat

@asinghvi17
Copy link
Member

This should also be made clear in the recipes page and the docstring for the recipe and block macros!

@asinghvi17 asinghvi17 added documentation Makie Backend independent issues (Makie core) labels Apr 13, 2024
@ffreyer
Copy link
Collaborator

ffreyer commented Apr 13, 2024

I think we need to figure out some stricter naming rules in general. I.e. fix #2555 too, and probably revive #2520

@jkrumbiegel
Copy link
Member

I think our attribute naming problems just mirror general Julia naming problems, because the convention to not use underscores is broken whenever it looks bad to the committer. But maybe it's not so important anymore after 0.21 when unknown attributes will error, as you're then reminded more easily of the correct form.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug documentation Makie Backend independent issues (Makie core)
Projects
None yet
Development

No branches or pull requests

4 participants