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

Doc of getproperty polluted by BunchKaufman and QRSparse #27119

Closed
mauro3 opened this issue May 16, 2018 · 1 comment · Fixed by #40135
Closed

Doc of getproperty polluted by BunchKaufman and QRSparse #27119

mauro3 opened this issue May 16, 2018 · 1 comment · Fixed by #40135
Labels
domain:docs This change adds or pertains to documentation domain:linear algebra Linear algebra

Comments

@mauro3
Copy link
Contributor

mauro3 commented May 16, 2018

Running ?Base.getproperty prints a long help text on extracting factors of above two factorizations. This is the wrong place for those to be: if I would look for them I would not type ?Base.getproperty and if I type ?Base.getproperty I certainly am not interested in those. They probably should be moved to the documentation of the types themselves, which is currently empty.
(Also, the types in some of the doc-strings are outdated due to stdlib-move)

X-ref: #25184
(Add Doc and LinearAlgebra labels)

@fredrikekre fredrikekre added domain:docs This change adds or pertains to documentation domain:linear algebra Linear algebra labels May 16, 2018
@fredrikekre
Copy link
Member

I feel like we don't need have docstrings for getproperty on those. Can't we just document the F.L etc accessors in the docstring for the factorization?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
domain:docs This change adds or pertains to documentation domain:linear algebra Linear algebra
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants