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

Add comments to AbstractionBillingPeriodService #93

Merged
merged 2 commits into from
Jan 20, 2023

Conversation

Cruikshanks
Copy link
Member

https://eaflood.atlassian.net/browse/WATER-3834

The AbstractionBillingPeriodService is doing some hairy stuff with dates. With no context as to the reasons why it becomes at risk of becoming a confusing mess like the legacy code.

So, this attempts to add some context and examples to the service to help explain what it is doing, but more importantly why.

https://eaflood.atlassian.net/browse/WATER-3834

The `AbstractionBillingPeriodService` is doing some hairy stuff with dates. With no context as the reasons why it becomes at risk of becoming a confusing mess like the legacy code.

So, this attempts to add some context and examples to the service to help explain what it is doing, but more importantly why.
@Cruikshanks Cruikshanks added the documentation Improvements or additions to documentation label Jan 20, 2023
@Cruikshanks Cruikshanks self-assigned this Jan 20, 2023
@Cruikshanks Cruikshanks marked this pull request as ready for review January 20, 2023 09:50
Copy link
Contributor

@Jozzey Jozzey left a comment

Choose a reason for hiding this comment

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

@Cruikshanks Cruikshanks merged commit 859dfdb into main Jan 20, 2023
@Cruikshanks Cruikshanks deleted the add-documentation-to-abstraction-periods branch January 20, 2023 16:37
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants