Bug 280241 - Documentation for KStandardDirs::locateLocal() is somewhat unclear
Summary: Documentation for KStandardDirs::locateLocal() is somewhat unclear
Status: RESOLVED WORKSFORME
Alias: None
Product: kdelibs
Classification: Unmaintained
Component: kdecore (show other bugs)
Version: 4.9-Git
Platform: unspecified Unspecified
: NOR minor
Target Milestone: ---
Assignee: kdelibs bugs
URL:
Keywords:
Depends on:
Blocks:
 
Reported: 2011-08-17 05:52 UTC by Akarsh Simha
Modified: 2022-11-12 05:15 UTC (History)
0 users

See Also:
Latest Commit:
Version Fixed In:
Sentry Crash Report:


Attachments

Note You need to log in before you can comment on or make changes to this bug.
Description Akarsh Simha 2011-08-17 05:52:41 UTC
Version:           Git (using Devel) 
OS:                unspecified

This is regarding the API reference on KStandardDirs that I found here:

http://tinyurl.com/3s7fuaw

The reference for locateLocal() does not emphasize that it looks only in the local data directories like $HOME as opposed to /usr/share,
although that is possibly implied by its name.

This did confuse me for a while, because the documentation says it's much like locate() and lists what seem like some differences, but does not list the primary difference between locate and locateLocal.

Reproducible: Always

Steps to Reproduce:
Open the website :)


Expected Results:  
I would prefer better documentation, that explains what locate() and locateLocal() do more explicitly.
Comment 1 Justin Zobel 2022-10-13 04:47:34 UTC
Thank you for reporting this bug in KDE software. As it has been a while since this issue was reported and confirmed, can we please ask you to see if you can reproduce the issue with a recent software version?

If you can reproduce the issue, please change the status to "CONFIRMED" when replying. Thank you!
Comment 2 Bug Janitor Service 2022-10-28 05:02:20 UTC
Dear Bug Submitter,

This bug has been in NEEDSINFO status with no change for at least
15 days. Please provide the requested information as soon as
possible and set the bug status as REPORTED. Due to regular bug
tracker maintenance, if the bug is still in NEEDSINFO status with
no change in 30 days the bug will be closed as RESOLVED > WORKSFORME
due to lack of needed information.

For more information about our bug triaging procedures please read the
wiki located here:
https://community.kde.org/Guidelines_and_HOWTOs/Bug_triaging

If you have already provided the requested information, please
mark the bug as REPORTED so that the KDE team knows that the bug is
ready to be confirmed.

Thank you for helping us make KDE software even better for everyone!
Comment 3 Bug Janitor Service 2022-11-12 05:15:06 UTC
This bug has been in NEEDSINFO status with no change for at least
30 days. The bug is now closed as RESOLVED > WORKSFORME
due to lack of needed information.

For more information about our bug triaging procedures please read the
wiki located here:
https://community.kde.org/Guidelines_and_HOWTOs/Bug_triaging

Thank you for helping us make KDE software even better for everyone!