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

The python.install requires the path key #11300

Closed
wants to merge 1 commit into from
Closed

The python.install requires the path key #11300

wants to merge 1 commit into from

Conversation

jeffwidman
Copy link
Contributor

@jeffwidman jeffwidman commented Apr 24, 2024

The path key seems to be required per:


📚 Documentation previews 📚

@jeffwidman jeffwidman requested a review from a team as a code owner April 24, 2024 00:00
@jeffwidman jeffwidman requested a review from ericholscher April 24, 2024 00:00
stsewd pushed a commit that referenced this pull request Apr 24, 2024
…th` (#11301)

This confused me initially because I was looking in https://docs.readthedocs.io/en/stable/config-file/v2.html#packages for `python.install.package`, which simply doesn't exist.

Instead, this should probably be `python.install.path` which _is_ a required key (#11300), and defaults to `pip`.
@humitos
Copy link
Member

humitos commented Apr 24, 2024

I'm pinging @stsewd here since I think that the :Required: bullet in the documentation refers to the whole section. In this case I understand that required: false means that you can use python.install without using .path.

@humitos humitos requested a review from stsewd April 24, 2024 10:06
Copy link
Member

@stsewd stsewd left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think this makes sense. And how it's currently documented, we separate both options in different sections (requirements file and packages).

Can we also change the requirements key to also be marked as required in the docs, so it's consistent with this change?

@stsewd
Copy link
Member

stsewd commented Apr 24, 2024

Actually, looks like we changed these in #10303

@jeffwidman
Copy link
Contributor Author

Afraid I'm not actually sure what the best outcome is here... all I know is that:

  1. I was confused as a user because requirements and package installs are both listed as optional.
  2. I noticed my VScode editor was pulling in the schema file, and saying the path key was required.

So there's an apparent inconsistency between the schema and docs... But I get what you're saying @humitos that really what's required is to have either the path key or the requirements key, but that the confusion likely stems from the documentation putting them in separate subsections... at least that's what I'm grok'ing so far.

If my understanding is correct, then perhaps the schema file is actually what needs updating?

And then perhaps clarify in the docs that "one of either requirements or path is required..." ??

@stsewd
Copy link
Member

stsewd commented Apr 24, 2024

I like the suggestion from #10303 (comment), writing "required when..."

If my understanding is correct, then perhaps the schema file is actually what needs updating?

Schema is fine, we have two installation methods, and each requires a different key, we could have used two different "parent keys" so they don't share the same parent key, but that ship already sailed...

@jeffwidman
Copy link
Contributor Author

I'm not sure there's a clear next action here, as documenting this solely for conda feels weird to me... so I'm going to close this.

@jeffwidman jeffwidman closed this Aug 12, 2024
@jeffwidman jeffwidman deleted the patch-1 branch August 12, 2024 18:22
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.

3 participants