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

Minor archive docs feedback #219

Closed
bhsiaoNFLX opened this issue Jan 27, 2021 · 2 comments
Closed

Minor archive docs feedback #219

bhsiaoNFLX opened this issue Jan 27, 2021 · 2 comments

Comments

@bhsiaoNFLX
Copy link
Contributor

bhsiaoNFLX commented Jan 27, 2021

If the state conditional is:

function archive (schema) {
  ...
  state < '${states.active}' AND keepUntil < now()
  ...

I.e. configuration.md should really be:

"...created and retry state before it's archived"

Am I right?

Also, archiveCompletedAfterSeconds is currently missing documentation even though there's a unit test for it. It should be documented.

If you agree, happy to create a PR :)

@bhsiaoNFLX bhsiaoNFLX changed the title Minor doc update request for retention Minor archive docs feedback Jan 27, 2021
@timgit
Copy link
Owner

timgit commented Jan 27, 2021

Yes. Please open a PR. Thanks!

bhsiaoNFLX added a commit to bhsiaoNFLX/pg-boss that referenced this issue Jan 27, 2021
@bhsiaoNFLX
Copy link
Contributor Author

bhsiaoNFLX commented Jan 27, 2021

timgit added a commit that referenced this issue Jan 28, 2021
doc (#219): add missing option and precise wording
@timgit timgit closed this as completed Jan 28, 2021
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

No branches or pull requests

2 participants