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

fix one-sentence summary in docstring for site_config_dir #179

Open
NickleDave opened this issue May 21, 2022 · 0 comments
Open

fix one-sentence summary in docstring for site_config_dir #179

NickleDave opened this issue May 21, 2022 · 0 comments

Comments

@NickleDave
Copy link

NickleDave commented May 21, 2022

very minor thing (probably why no-one has noticed it) but the one-sentence summary for site_config_dir is wrong, guessing because someone copied the docstring from site_data_dir (not that I have ever been guilty of this 😇 )

r"""Return full path to the user-shared data dir for this application.

def site_config_dir(appname=None, appauthor=None, version=None, multipath=False):
    r"""Return full path to the user-shared data dir for this application.

Happy to fix a PR if you want it fixed, probably it should be a one-word change to match user_config_dir

    r"""Return full path to the user-shared config dir for this application.
@NickleDave NickleDave changed the title fix docstring fix one-sentence summary in docstring for site_config_dir May 21, 2022
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

No branches or pull requests

1 participant