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: clean docs for $list methods #724

Merged
merged 10 commits into from
Jan 21, 2024
Merged

Conversation

etiennebacher
Copy link
Collaborator

Style:

  • remove useless @format and @keywords
  • harmonize examples:
    • reuse same data when possible
    • use with_columns() instead of select() to show input and output side-by-side
    • when applicable, have an example with Expr and one with literal
  • fix typos and weird sentences
  • better titles

Other:

  • deprecate $list$lengths(), use $list$len() instead
  • remove the S3 [ that was an alias for $list$get(), it just seemed weird to me to have this single method in there and I can't imagine it's easier to use. Ok to revert if necessary though

Copy link
Collaborator

@eitsupi eitsupi left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Great!

Could you update NEWS as a breaking change?

@etiennebacher
Copy link
Collaborator Author

Thanks, done

@etiennebacher etiennebacher merged commit 995e4eb into main Jan 21, 2024
@etiennebacher etiennebacher deleted the improve-docs-exprlist branch January 21, 2024 10:45
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.

None yet

2 participants