docs(config): replace deprecated IConfig app/user value examples#14964
Open
skjnldsv wants to merge 1 commit into
Open
docs(config): replace deprecated IConfig app/user value examples#14964skjnldsv wants to merge 1 commit into
skjnldsv wants to merge 1 commit into
Conversation
skjnldsv
requested review from
CarlSchwan,
ChristophWurst,
come-nc,
cristianscheid,
pringelmann and
provokateurin
Contributor
📖 Documentation Preview📄 1 changed documentation pageLast updated: Wed, 27 May 2026 09:03:07 GMT |
provokateurin
requested changes
May 21, 2026
come-nc
reviewed
May 26, 2026
Contributor
come-nc
left a comment
come-nc
left a comment
There was a problem hiding this comment.
I agree with Kate about the code example, the IConfig one needs to be changed to be more like the IAppConfig one.
Contributor
|
Also, Lexicon should be mentioned in there. |
- Rewrite system values code example with meaningful typed methods (getSystemValueString, getSystemValueInt, getSystemValueBool) instead of generic untyped getSystemValue/setSystemValue - Integrate typed method guidance into prose, remove separate note block - Rename "User values" section to "User settings" - Add Lexicon cross-reference to the configuration overview - Fix broken doc cross-references in storage/configuration Signed-off-by: skjnldsv <skjnldsv@protonmail.com>
skjnldsv
force-pushed
the
fix/appconfig-iconfig-deprecated-docs
branch
from
606790f to
183f1fb
Compare
Member
Author
|
Done @come-nc @provokateurin |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
☑️ Resolves
Summary
basics/storage/configuration.rstshowedIConfig::getAppValue/setAppValueandIConfig::getUserValue/setUserValueas the recommended approach. Both are deprecated.Changes:
OCP\AppFramework\Services\IAppConfig(deprecated since NC29). Added typed getter/setter example and cross-ref to the fullappconfig.rstreference.\OCP\Config\IUserConfig(deprecated since NC31). Added typed getter/setter example and cross-ref to the fulluserconfig.rstreference.IConfigis still the correct interface there.Needs backports to stable30 and stable29 per maintainer comment on the issue.
🖼️ Screenshots
✅ Checklist
codespellor similar and addressed any spelling issues