Skip to content

🐛 fix(pdoc): correct four misspelled __pdoc__ kwargs #710

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

Merged
nstarman merged 2 commits into from
Aug 14, 2026
Merged

🐛 fix(pdoc): correct four misspelled __pdoc__ kwargs #710

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
ab67a8d
🐛 fix(pdoc): correct four misspelled `__pdoc__` kwargs
nstarman Aug 13, 2026
898a4c5
✅ test(interop-astropy): update the two doctests the kwarg fix moved
nstarman Aug 13, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions packages/coordinaxs.interop.astropy/src/coordinaxs/interop/astropy/_src/frames.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -315,7 +315,7 @@ def from_(
frame=ICRS()
),
roll=Angle(f64[], 'deg'),
z_sun=Quantity(f64[], 'pc'),
z_sun=Q(f64[], 'pc'),
galcen_v_sun=Tangent(
{'x': Q(f64[], 'km / s'), 'y': Q(f64[], 'km / s'), 'z': Q(f64[], 'km / s')},
chart=Cart3D(M=Rn(3)),
Expand Down Expand Up @@ -397,7 +397,7 @@ def astropy_galactocentric_to_coordinax_galactocentric(
frame=ICRS()
),
roll=Angle(f64[], 'deg'),
z_sun=Quantity(f64[], 'pc'),
z_sun=Q(f64[], 'pc'),
galcen_v_sun=Tangent(
{'x': Q(f64[], 'km / s'), 'y': Q(f64[], 'km / s'), 'z': Q(f64[], 'km / s')},
chart=Cart3D(M=Rn(3)),
Expand Down
8 changes: 4 additions & 4 deletions src/coordinax/_src/base/charts.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -242,19 +242,19 @@ def __pdoc__(self, *, include_params: bool = True, **kw: Any) -> wl.AbstractDoc:

>>> wl.pprint(cxc.ProlateSpheroidal3D(Delta=u.StaticQuantity(20, "km")))
ProlateSpheroidal3D[('mu', 'nu', 'phi'), ('area', 'area', 'angle')](
Delta=StaticQuantity(i64[](numpy), unit='km'), M=Rn(3)
Delta=StaticQuantity(i64[](numpy), 'km'), M=Rn(3)
)

>>> wl.pprint(cxc.ProlateSpheroidal3D(Delta=u.StaticQuantity(20, "km")),
... short_arrays=False)
ProlateSpheroidal3D[('mu', 'nu', 'phi'), ('area', 'area', 'angle')](
Delta=StaticQuantity(array(20), unit='km'), M=Rn(3)
Delta=StaticQuantity(array(20), 'km'), M=Rn(3)
)

"""
kw.setdefault("short_arrays", "compact")
kw.setdefault("use_short_names", True)
kw.setdefault("named_units", False)
kw.setdefault("use_short_name", True)
kw.setdefault("named_unit", False)
kw.setdefault("hide_defaults", True)

if include_params:
Expand Down
2 changes: 1 addition & 1 deletion src/coordinax/frames/_src/base.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -76,7 +76,7 @@ def __pdoc__(self, **kw: object) -> wl.AbstractDoc:
# Set defaults for pdoc kwargs
kw.setdefault("include_params", False)
kw.setdefault("short_arrays", "compact")
kw.setdefault("use_short_names", True)
kw.setdefault("use_short_name", True)
kw.setdefault("named_unit", False)

# Include only fields that differ from their default values.
Expand Down
2 changes: 1 addition & 1 deletion src/coordinax/transforms/_src/actions/add.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -134,7 +134,7 @@ def __pdoc__(self, **kw: Any) -> wl.AbstractDoc:
# Set pdoc option defaults
kw.setdefault("include_params", False)
kw.setdefault("short_arrays", "compact")
kw.setdefault("use_short_names", True)
kw.setdefault("use_short_name", True)
kw.setdefault("named_unit", False)

# Build the fields
Expand Down