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

chore: clean docs of expr_expr.R #510

Merged
merged 18 commits into from
Nov 18, 2023
Merged

chore: clean docs of expr_expr.R #510

merged 18 commits into from
Nov 18, 2023

Conversation

etiennebacher
Copy link
Collaborator

@etiennebacher etiennebacher commented Nov 14, 2023

No description provided.

@etiennebacher etiennebacher changed the title Clean docs of expr_expr.R chore: clean docs of expr_expr.R Nov 18, 2023
etiennebacher and others added 2 commits November 18, 2023 07:54
Merge branch 'main' into expr-expr-docs

# Conflicts:
#	R/expr__expr.R
#	man/Expr_cum_count.Rd
#	man/Expr_cum_prod.Rd
#	man/Expr_cum_sum.Rd
#	man/Expr_cummin.Rd
#	man/Expr_explode.Rd
#	man/Expr_gather.Rd
#	man/Expr_gather_every.Rd
@etiennebacher etiennebacher mentioned this pull request Nov 18, 2023
@etiennebacher etiennebacher marked this pull request as ready for review November 18, 2023 11:50
@eitsupi
Copy link
Collaborator

eitsupi commented Nov 18, 2023

Sorry, but the differences are too large to review. It would be helpful if you could explain the intent of the changes.

@etiennebacher
Copy link
Collaborator Author

Sure, I know this is a lot and I'm not expecting you to review everything. Here are the main changes:

  • clean text: fix capitalization, typos, structure of sentences, code formatting, wrap text at 80 characters
  • clean tags: use @inheritParams where possible, remove duplicated tags, remove unnecessary tags (e.g @name since this is automatically detected by roxygen2)
  • clearer examples: use $with_columns() instead of $select() to show the output side by side with the input, remove unnecessarily long examples
  • sometimes some functions were gathered in the same Rd file, so I split them to have one function per file

This is basically the same things I did in other PRs, but this file is massive which explains the number of changes

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.

Thanks for the hard work!

@eitsupi eitsupi merged commit 11af69c into main Nov 18, 2023
17 checks passed
@eitsupi eitsupi deleted the expr-expr-docs branch November 18, 2023 14:07
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