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

The documentation is missing the definition for plane_symbol helper function #899

Open
Niketin opened this issue Feb 9, 2025 · 0 comments
Labels
documentation Improvements or additions to documentation

Comments

@Niketin
Copy link

Niketin commented Feb 9, 2025

In the documentation, there is a definition for a helper function location_symbol

def location_symbol(self, l=1) -> Compound:
return Compound.make_triad(axes_scale=l).locate(self)
and it is used in the following example code.
show_object(location_symbol(loc), name="location")

There is a similar function for planes, plane_symbol, and it is also used in the same way as location_symbol.

show_object(plane_symbol(plane), name="plane")

The problem is that the function's definition is not documented anywhere on the page (or anywhere else as far as I know).

@gumyr gumyr added the documentation Improvements or additions to documentation label Feb 20, 2025
@gumyr gumyr added this to the Not Gating Release 1.0.0 milestone Feb 20, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

2 participants