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

Massages wording on why hamilton in docs #634

Merged
merged 1 commit into from
Jan 13, 2024
Merged

Massages wording on why hamilton in docs #634

merged 1 commit into from
Jan 13, 2024

Conversation

skrawcz
Copy link
Collaborator

@skrawcz skrawcz commented Jan 13, 2024

So that the categories are more clearly defined.
Provides some framing to start the section.

Changes

  • docs

How I tested this

  • locally

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.

So that the categories are more clearly defined.
Provides some framing to start the section.
Copy link
Contributor

sweep-ai bot commented Jan 13, 2024

Apply Sweep Rules to your PR?

  • Apply: All new business logic should have corresponding unit tests.
  • Apply: Refactor large functions to be more modular.
  • Apply: Add docstrings to all functions and file headers.

This is an automated message generated by Sweep AI.

@skrawcz skrawcz merged commit 93733f0 into main Jan 13, 2024
22 checks passed
@skrawcz skrawcz deleted the touch_up_docs branch January 13, 2024 07:31
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.

1 participant