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

Updates doc strings to use imperative writing style #329

Merged
merged 1 commit into from
Sep 10, 2023

Conversation

bryangalindo
Copy link
Contributor

@bryangalindo bryangalindo commented Sep 10, 2023

Minor doc string updates to keep uniform doc string writing style (i.e., imperative). Also, I wanted to introduce a small PR to get comfortable with the PR flow since I'm a new contributor.

Changes

Updates examples/polars/my_functions.py doc strings.

How I tested this

Ran all unit tests locally successfully.

Notes

Checklist

  • PR has an informative and human-readable title (this will be pulled into the release notes)
  • Changes are limited to a single goal (no scope creep)
  • Code passed the pre-commit check & code is left cleaner/nicer than when first encountered.
  • Any change in functionality is tested
  • New functions are documented (with a description, list of inputs, and expected output)
  • Placeholder code is flagged / future TODOs are captured in comments
  • Project documentation has been updated if adding/changing functionality.

@skrawcz skrawcz merged commit fb7102e into DAGWorks-Inc:main Sep 10, 2023
@bryangalindo bryangalindo deleted the updates-polars-doc-strings branch September 11, 2023 02:36
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