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

Document get_cachedir() in troubleshooting #4860

Merged
merged 4 commits into from Aug 4, 2015

Conversation

rsnape
Copy link
Contributor

@rsnape rsnape commented Aug 4, 2015

On unix-like systems, configuration directory and cache directory are normally different. Document how to locate cache dir in troubleshooting FAQ

On unix-like systems, configuration directory and cache directory are normally different. Document how to locate cache dir in troubleshooting FAQ
@rsnape
Copy link
Contributor Author

rsnape commented Aug 4, 2015

As per @tacaswell request here, creating a pull request to document the use of get_cachedir() in troubleshooting FAQ - useful when user needs to clear tex.cache in particular and maybe other cache based issues. Related matplotlib-user thread here.

@tacaswell
Copy link
Member

Could you also correct the section above the new text? The default configuration path is now ~/.config/matplotlib.

Configuration directory matplotlib now resides
under directory .config by default.  Update
docs to reflect that
Make wording clear where `matplotlib` directory sits
under `~/.config`
@rsnape
Copy link
Contributor Author

rsnape commented Aug 4, 2015

Oops! I thought I'd caught everything by checking Windows behaviour too. Now added the new default .config location and wording around it. Sorry for pushing two commits.

@@ -34,31 +34,44 @@ and printing the ``__file__`` attribute::

.. _locating-matplotlib-config-dir:

:file:`.matplotlib` directory location
======================================
:file:`.matplotlib` and `.cache` directory location
Copy link
Member

Choose a reason for hiding this comment

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

well, it isn't called .matplotlib anymore, right?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

fair comment, I'll amend the title

Improved and corrected wording in response to @WeatherGod comments
on commit 991d321
@WeatherGod
Copy link
Member

+1 from me once Travis passes.

tacaswell added a commit that referenced this pull request Aug 4, 2015
DOC: Document get_cachedir() in troubleshooting
@tacaswell tacaswell merged commit e9e8acb into matplotlib:master Aug 4, 2015
@tacaswell
Copy link
Member

@rsnape Thanks!

@rsnape rsnape deleted the rsnape-doc-cachedir branch August 5, 2015 13:56
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.

None yet

3 participants