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 examples for all funcs, license tweak, func name clarifications #121

Merged
merged 3 commits into from
Feb 9, 2021

Conversation

JohnRoesler
Copy link
Contributor

@JohnRoesler JohnRoesler commented Feb 9, 2021

What does this do?

  • adds examples for all functions
  • removes all examples from the readme
  • renames a few functions and changes some signatures
  • moves the license to an MIT license (almost the same wording) - gets a nice standard license

Which issue(s) does this PR fix/relate to?

resolves #95

List any changes that modify/break current functionality

  • The job Tag func now accepts a variadic string parameter instead of a slice
  • The scheduler SetTag is now Tag and also accepts a variadic string parameter
  • The scheduler RemoveJobByTag is now RemoveByTag to be consistent with Remove and RemoveByReference
  • The scheduler RunAllWithDelay func now accepts a time.Duration instead of an int representing seconds
  • The scheduler Scheduled func is now TaskPresent - scheduled was confusing name because until the scheduler is started, it's not actually "scheduled to run". Now you can check whether the task is present in the scheduler.

Have you included tests for your changes?

👍

Did you document any new/modified functionality?

  • Updated example_test.go
  • Updated README.md

Notes

@JohnRoesler JohnRoesler merged commit 507947a into go-co-op:master Feb 9, 2021
@JohnRoesler JohnRoesler deleted the examples-etc branch February 9, 2021 15:11
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.

Add examples for all exported functions to example_test.go for go documentation
2 participants