Skip to content

Enhance polars plugin documentation#15250

Merged
ayax79 merged 3 commits intonushell:mainfrom
MMesch:mmesch/polars-enhanced-doc-stub
Mar 5, 2025
Merged

Enhance polars plugin documentation#15250
ayax79 merged 3 commits intonushell:mainfrom
MMesch:mmesch/polars-enhanced-doc-stub

Conversation

@MMesch
Copy link
Copy Markdown
Contributor

@MMesch MMesch commented Mar 5, 2025

This PR (based on #15249 and #15248 because it mentions them) adds extra documentation to the main polars command outlining the main datatypes that are used by the plugin. The lack of a description of the types involved in polars xxx commands was quite confusing to me when I started using the plugin and this is a first try improving it.

I didn't find a better place but please let me know what you think.

@MMesch MMesch force-pushed the mmesch/polars-enhanced-doc-stub branch 3 times, most recently from 8897591 to b304536 Compare March 5, 2025 11:03
@fdncred fdncred added category:documentation issues relating to documentation deprecated:pr-plugins Deprecated: use the A:plugins label instead labels Mar 5, 2025
@fdncred fdncred added the A:plugin-polars Work related to the polars dataframe implementation label Mar 5, 2025
@MMesch MMesch force-pushed the mmesch/polars-enhanced-doc-stub branch from b304536 to 2d0118b Compare March 5, 2025 13:01
@MMesch
Copy link
Copy Markdown
Contributor Author

MMesch commented Mar 5, 2025

@fdncred I can also close the two other PRs and only keep this one which includes all changes.

@fdncred
Copy link
Copy Markdown
Contributor

fdncred commented Mar 5, 2025

I've asked @ayax79 to take a look at your PRs. So, let's wait for him to help decide what is best.

@ayax79 ayax79 merged commit 087fe48 into nushell:main Mar 5, 2025
15 checks passed
@github-actions github-actions bot added this to the v0.103.0 milestone Mar 5, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

A:plugin-polars Work related to the polars dataframe implementation category:documentation issues relating to documentation deprecated:pr-plugins Deprecated: use the A:plugins label instead

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants