Better default for `pathed_env_vars` about rez HOT 7 CLOSED

#1475 will improve the documentation. You can see the improvements at https://rez--1475.org.readthedocs.build/en/1475/configuring_rez.html#pathed_env_vars.

If anything, we need user guides for our shells. Though, even with user guides, I wouldn't necessarily say "You should add x, y, y to x" and would more say "you might need to tweak these settings" to stay neutral.

from rez.

I think the safest we can do right now is *PATH, which is currently the default. The thing is that we have to be careful to not unnecessarily break anyone. Default values are there to cover some/most cases, not all cases.

from rez.

Yes that is what makes me hesitant to post because that could be a breaking change.
Then what do you think of at least giving a hint in the documentation that it would be recommended to add this additional variable ?

from rez.

thanks for sharing the pr, those are nice improvements.

would more say "you might need to tweak these settings" to stay neutral.

yes totally
so perhaps this issue should be part of a bigger issue about "user guides" ? If so I am fine with closing this issue.

from rez.

Yeah I think so. If you feel like it, you can comment on #1277 to add docs for our shell plugins and link to your GH issue.

Additionally, we are looking for people to help us with docs, so if you want to contribute, adding docs would be a great way to contribute :)

from rez.

Great, I try that.

from rez.

Comment added to #1277.
Closing this.

from rez.