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.

Sign up for GitHub

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

Jump to bottom

docs: improve config option descriptions, names and error reporting #163

Merged
merged 6 commits into from
Aug 8, 2023
Merged

docs: improve config option descriptions, names and error reporting #163

merged 6 commits into from
Aug 8, 2023

Conversation

jmbuhr
Copy link
Collaborator

@jmbuhr jmbuhr commented Jul 31, 2023 •
edited
Loading

  • clean up ambiguous config options
    • iterations: is now max_tasks
  • auto-link type annotations in docs

@jmbuhr jmbuhr mentioned this pull request Jul 31, 2023
Merged
@jmbuhr jmbuhr mentioned this pull request Aug 7, 2023
Merged
@KRiedmiller
Copy link
Collaborator

The idea of iterations was that some jobs might add tasks on their own, like in the priority queue. Iterations would be a failsafe so KIMMDY does not run forever in case of a loop (which might be intentional).
Though, I don't think such loops are currently possible with our sequence

@jmbuhr
refactor(names): rename for consistency.
859e4c0 
schema = json schema, scheme = dictionary with just pytype, description,
defaults
@jmbuhr
docs(types): add custom renderer
1d22131 
now auto-links type annotations.
Can be removed once the feature is upstreamed in
quartodoc

refactor(naming): change `iterations` to `max_tasks`

and add useful description for it.

chore(docs): render
@jmbuhr jmbuhr merged commit 3318bdc into main Aug 8, 2023
3 of 4 checks passed
@jmbuhr jmbuhr deleted the docs/descriptions-and-errors branch August 8, 2023 09:16
@github-actions github-actions bot mentioned this pull request Aug 8, 2023
Merged
@KRiedmiller KRiedmiller mentioned this pull request Aug 9, 2023
Closed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
No reviews
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@jmbuhr @KRiedmiller