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.

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

Jump to bottom

Add Type Reference Documentation #221

Open
copperlight opened this issue Jan 7, 2021 · 1 comment
Open

Add Type Reference Documentation #221

copperlight opened this issue Jan 7, 2021 · 1 comment
Labels
documentation Improvements or additions to documentation

Comments

@copperlight
Copy link

While working through the HLB tutorial, it took awhile for me to realize that the fs return type means filesystem.

As far as I can tell, there is no single page that lists all of the possible types that may exist in HLB with a short description of them.

It would be useful to have a page that provides an overview of all of the available types.

Maybe consider Python Built-in Types as an example, although it is likely more verbose than needed at first?

https://docs.python.org/3/library/stdtypes.html
@hinshun
Copy link
Contributor

hinshun commented Jan 7, 2021

Yes definitely, I'll keep this in mind for our docs overhaul.

@hinshun hinshun added the documentation Improvements or additions to documentation label Jan 7, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
documentation Improvements or additions to documentation
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@copperlight @hinshun