Skip to content

Fix config dir typo in doc - #6512

Merged
bsipocz merged 1 commit into
astropy:masterfrom
pllim:fix-config-doc
Sep 5, 2017
Merged

bsipocz merged 1 commit into
astropy:masterfrom
pllim:fix-config-doc

Conversation

@pllim

@pllim pllim commented Sep 5, 2017

Copy link
Copy Markdown
Member

While composing #6511, I noticed a typo in the directory name.

p.s. Not sure if doc typo needs backporting, but milestoning to 2.x anyway; Feel free to move milestone as needed.

@astropy-bot

astropy-bot Bot commented Sep 5, 2017 •

Copy link
Copy Markdown

Hi there @pllim 👋 - 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! 👍

@bsipocz

bsipocz commented Sep 5, 2017

Copy link
Copy Markdown
Member

Thanks @pllim! PRs like this are absolutely fine for 2.0.x, they are always clean backports thus add basically no overhead, while keeping the docs cleaner and nicer for LST.

Merging as no need to wait for CI.

@bsipocz
bsipocz merged commit 14e66fd into astropy:master Sep 5, 2017
@pllim
pllim deleted the fix-config-doc branch September 5, 2017 15:42
@saimn

saimn commented Sep 5, 2017

Copy link
Copy Markdown
Contributor

I think the previous sentence was more correct: when $XDG_CONFIG_HOME is not defined, many software put their config in ~/.config by default. But there are also many others that put the config in ~/.<software>, so maybe this sentence is not needed at all, it just adds confusion.

@pllim

pllim commented Sep 5, 2017

Copy link
Copy Markdown
Member Author

On my RHEL7 machine, it defaults to ~/.astropy/config. I cannot find any ~/.config/astropy although ~/.config does exist and populated with other stuff.

@pllim

pllim commented Sep 5, 2017

Copy link
Copy Markdown
Member Author

@saimn , feel free to submit a follow-up if you think this is inaccurate.

@saimn

saimn commented Sep 5, 2017

Copy link
Copy Markdown
Contributor

@pllim - Understood, but the note you modified is about the behavior of most Linux applications. The paragraph just above mention that the default for Astropy is $HOME/.astropy/config. That's why I think that the note is confusing and could be removed. (I can submit a PR for this later if this makes sense)

@pllim

pllim commented Sep 5, 2017

Copy link
Copy Markdown
Member Author

@saimn , sure, please do. The note was indeed confusing because it was not the behavior I actually observed for Astropy.

bsipocz added a commit that referenced this pull request Sep 6, 2017
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants