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

Mark units defined in this package as public #749

Open
sostock opened this issue Nov 12, 2024 · 0 comments
Open

Mark units defined in this package as public #749

sostock opened this issue Nov 12, 2024 · 0 comments

Comments

@sostock
Copy link
Collaborator

sostock commented Nov 12, 2024

Currently, looking up docstrings for units produces a warning, since they are neither exported nor public.

help?> Unitful.W
  │ Warning
  │
  │  The following bindings may be internal; they may change or be
  │  removed in future versions:
  │
  │    •  Unitful.W

  Unitful.W

  The watt, an SI unit of power, defined as 1 J / s.

  Dimension: 𝐋^2 𝐌 𝐓^-3.

  See also: Unitful.J, Unitful.s.

The units defined by this package should be marked as public to avoid this.

We could ad an optional argument to the @unit macro that specifies whether the units should be marked public (so that users don’t have to do it individually for every SI prefix).

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

1 participant