-
-
Notifications
You must be signed in to change notification settings - Fork 1.7k
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
Remove note about config paths #6516
Conversation
Hi there @saimn 👋 - thanks for the pull request! I'm just a friendly 🤖 that checks for issues related to the changelog and making sure that this pull request is milestoned and labelled correctly. This is mainly intended for the maintainers, so if you are not a maintainer you can ignore this, and a maintainer will let you know if any action is required on your part 😃. Everything looks good from my point of view! 👍 |
Is it worth replacing it with a less confusing note that |
And is this |
@pllim - Good point, XDG is a linux thing (the X Desktop Group), but the code handles this independently from the OS. |
@pllim - I tried to explain a bit more |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This is much better. Thanks, @saimn !
Should let the CIs run though (no [skip ci]
) to make sure Sphinx gives no warning.
docs/config/index.rst
Outdated
configuration in ``~/.astropy/config``. | ||
scheme generally puts your configuration directory in | ||
``$HOME/.astropy/config``. It can be customized with the environment variable | ||
``XDG_CONFIG_HOME`` and the ``$XDG_CONFIG_HOME/astropy`` directory must exists. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I thought "must exist" is more grammatically correct but I am not 100% sure.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Ok thanks, I will update this and squash.
Passed (except the osx build that I've cancelled), so I'm merging now. Thanks @saimn! |
Follow up to #6512, see comments there for the motivation: this paragraph is confusing as it follows another paragraph on the Astropy default config path. And the information given here is not really useful I think.
cc @pllim @bsipocz