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

Corrected get_pref_path() documentation #2326

Conversation

IrvKalb
Copy link
Contributor

@IrvKalb IrvKalb commented Jul 17, 2023

The path generated by get_pref_path for MacOS should have included an extra folder using the "org" parameter. (In the example, this has the value of "My Company"). I tested this call on my Mac, and the generated path includes the value of "org" as an additional folder.

The path generated by get_pref_path should have included the "prg" parameter.  (In the example, this has the value of "My Company")
@IrvKalb IrvKalb requested a review from a team as a code owner July 17, 2023 16:36
Copy link
Member

@ankith26 ankith26 left a comment

Choose a reason for hiding this comment

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

Hi, thanks for making the PR.

The docs here was originally copied from the SDL docs for the underlying function (which also has this issue). I tested this on linux, and even on linux the orgname is taken into account as expected.

docs/reST/ref/system.rst Outdated Show resolved Hide resolved
@ankith26 ankith26 added the docs label Jul 17, 2023
@ankith26 ankith26 added this to the 2.3.1 milestone Jul 17, 2023
Co-authored-by: Ankith <46915066+ankith26@users.noreply.github.com>
Copy link
Member

@Starbuck5 Starbuck5 left a comment

Choose a reason for hiding this comment

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

Thanks!

Copy link
Member

@zoldalma999 zoldalma999 left a comment

Choose a reason for hiding this comment

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

Thanks!

@zoldalma999 zoldalma999 merged commit 8b0ec63 into pygame-community:main Jul 28, 2023
1 of 2 checks passed
@ankith26 ankith26 changed the title Corrected MacOS get_pref_path() documentation Corrected get_pref_path() documentation Aug 6, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants