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: fix broken link and update join documentation #29

Merged
merged 4 commits into from
Dec 26, 2022

Conversation

johanroelofsen
Copy link
Contributor

@johanroelofsen johanroelofsen commented Dec 24, 2022

If you have any suggestions how to best check / generate the tsdoc locally, I'm happy to learn.
For instance I think the @link of the join in dataframe should be JoinBaseOptions instead of JoinOptions but it did not find a easy way to check this myself

polars/dataframe.ts Outdated Show resolved Hide resolved
polars/lazy/dataframe.ts Show resolved Hide resolved
@universalmind303
Copy link
Collaborator

Thanks @johanroelofsen. You can run the docs locally yarn typedoc then opening up docs/index.html in your browser to view the docs locally. I primarily use the vscode typehints as a guide. If the docs look correct in your editor's typehints, likely they will end up correctly in typedoc.

image

@johanroelofsen
Copy link
Contributor Author

Thanks @johanroelofsen. You can run the docs locally yarn typedoc then opening up docs/index.html in your browser to view the docs locally. I primarily use the vscode typehints as a guide. If the docs look correct in your editor's typehints, likely they will end up correctly in typedoc.

image

Thanks for the clear explanation

@universalmind303 universalmind303 merged commit 79bec8b into pola-rs:main Dec 26, 2022
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

Successfully merging this pull request may close these issues.

2 participants