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

document type hierarchy #7782

Closed
RossBoylan opened this issue Jul 29, 2014 · 4 comments
Closed

document type hierarchy #7782

RossBoylan opened this issue Jul 29, 2014 · 4 comments
Labels
domain:docs This change adds or pertains to documentation

Comments

@RossBoylan
Copy link

Particularly for numbers, it would be good to have the type hierarchy and aliases in an easy to access place. http://docs.julialang.org/en/latest/stdlib/base/?highlight=log#standard-numeric-types
has concrete types only. The manual's discussion of abstract types gives some information but this is hard to find as reference material, and it is unclear if it is comprehensive or illustrative.

Aliases like Int should be in there too. Discussion of which types to use under which circumstances would also be helpful, though perhaps out of place in a reference manual.

A complete reference on the type hierarchy (not just Numeric) also seems it should be somewhere, though perhaps there isn't enough going on outside of numbers to justify it.

@ivarne
Copy link
Sponsor Member

ivarne commented Jul 29, 2014

Range also have quite a few subtypes that can be should be documented.

@pao
Copy link
Member

pao commented Jul 29, 2014

cf #987 for array types

@vtjnash
Copy link
Sponsor Member

vtjnash commented Mar 25, 2016

./julia examples/typetree.jl can generate this. would just need to have something automatically add it to the manual

@brenhinkeller
Copy link
Sponsor Contributor

Fixed by #45975 🎉

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
Projects
None yet
Development

No branches or pull requests

6 participants