Change a few configuration file options from required to not required #10303
Conversation
These are not required in our configuration specification Resolves #10302
There was a problem hiding this comment.
LGTM 👍
This is a very good case for having more automatic apidocs-like generation of the configuration file schema. But we'd probably have to rework a lot of our schema parsing for that to happen :)
Btw some more changes are in the pipeline in #9921
There was a problem hiding this comment.
I think the way the documentation is written makes this to be tricky.
For example, conda is not required at all. However, if you use the conda key, then conda. enviroment becomes required. I think this is what the documentation tries to communicate, but it's not clear.
|
@humitos aye, this is what I figured as well. I think this PR is at least more correct up front, but do agree we need a different way of describing when fields conditionally become required. I could make this instead |
|
I don't have any preference currently. I think we need to come back to this page anyways for a bigger refactor since it's one of the most linked page and we recommend it a lot. So, I think we should do some small research and se how other projects are presenting a config file reference and probably copy the one we like the most. This page has really good information on it, but it just needs to be re-structured in a more clearer way only. |
I think that sounds good to get this PR in and maintain correctness 👍 It would be super nice to do a refactor of this page! What I currently like about it is that everything has an anchor link so you can reference all options directly - and that everything is in the same page. What I don't like is that the schema's nested structures are unclear and it lacks more copy-paste friendly examples. |
| @@ -297,7 +297,7 @@ conda.environment | |||
| The path to the Conda `environment file <https://conda.io/projects/conda/en/latest/user-guide/tasks/manage-environments.html>`_, relative to the root of the project. | |||
|
|
|||
| :Type: ``path`` | |||
| :Required: ``true`` | |||
| :Required: ``false`` | |||
There was a problem hiding this comment.
| :Required: ``false`` | |
| :Required: when using the ``conda`` key |
There was a problem hiding this comment.
I'll leave this change for later for now, as we have a number of fields we should do this for.
These are not required in our configuration specification
Resolves #10302
📚 Documentation previews 📚
docs): https://docs--10303.org.readthedocs.build/en/10303/dev): https://dev--10303.org.readthedocs.build/en/10303/