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

docs: readme to suggest edit-config instead of config-file #505

Open
wants to merge 2 commits into
base: master
Choose a base branch
from

Conversation

ath0mas
Copy link

@ath0mas ath0mas commented Sep 26, 2023

PR Type

What kind of change does this PR introduce?

  • Bugfix
  • Feature
  • Code style update (formatting, local variables)
  • Refactoring (no functional changes, no api changes)
  • Documentation changes
  • Other... Please describe:

What is the purpose of this PR?

<edit-config> is the proper way to override the usage description messages, not <config-file>.

And removes the platform attribute that does neither exist on <onfig-file> nor on <edit-config>.

What testing has been done on existing functionality?

Defining one same NS*UsageDescription with different values gave me the following results:

  1. first "expected to override all" value in config.xml through <config-file>, then inside one or more plugin.xml from installed plugins: the finally applied value is the one from the last plugin 🤔
  2. first "expected to override all" value in config.xml through <edit-file>, then inside one or more plugin.xml from installed plugins: the finally applied value is the one from config.xml ✅

config-file sets initial values, then possibly defined by plugins too, and finally edit-config allows to force the final values
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

1 participant