This repository was archived by the owner on Feb 11, 2026. It is now read-only.
fix(doc): remove DRY-violating config param tables#436
Merged
Conversation
- remove the configuration parameter tables, which violate DRY and are therefore inconsistent with the YAML file for some algorithms - require docstring for including configuration documentation, for algorithms that have a `Config.yaml` file
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Config.yamlfile@include'd YAML files (assumes the syntax is "close enough" to Python, for correct coloring; works well, surprisingly)