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

docs: multiple questions about starlark parameter types #135

Open
dustmop opened this issue Oct 1, 2021 · 0 comments
Open

docs: multiple questions about starlark parameter types #135

dustmop opened this issue Oct 1, 2021 · 0 comments

Comments

@dustmop
Copy link
Contributor

dustmop commented Oct 1, 2021

How do the starlark docs represent optional parameters? Should we use an a question mark such as:

func(n?)

If so, should the page render this ? differently to make it stand out better? Perhaps a different font?

How do complex types get represented? For example "list of strings" or "tuple of two ints". One possibility is using list(string) and (int,int). Note that we can't use (int, int) because the outline parser sees the space and terminates the token.

How do we represent any types? What about type unions? For example, many DataFrame methods have parameters that are allowed to be a "list, or Series, or DataFrame, or iterable".

The answers to these types of questions should be standardized so that the docs are consistent.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant