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(config): Clarify config precendence #32623

Open
wants to merge 3 commits into
base: main
Choose a base branch
from

Conversation

KUGA2
Copy link

@KUGA2 KUGA2 commented Nov 19, 2024

Changes

  • Add possible options for global config
  • State that the order is the precedence order
  • Fix order

Context

#32598

Documentation (please check one with an [x])

  • I have updated the documentation, or
  • No documentation update is required

How I've tested my work (please select one)

I have verified these changes via:

  • Code inspection only, or
  • Newly added/modified unit tests, or
  • No unit tests but ran on a real repository, or
  • Both unit tests + ran on a real repository
  • None of that. Its documentation only.

- Add possible options for global config
- State that the order is the precedence order
- Fix order
@KUGA2 KUGA2 changed the title Update config precedence [improve][doc] Clarify config precendence Nov 19, 2024
@KUGA2 KUGA2 changed the title [improve][doc] Clarify config precendence docs(config): Clarify config precendence Nov 19, 2024
rarkins
rarkins previously approved these changes Nov 19, 2024
docs/usage/config-overview.md Outdated Show resolved Hide resolved
Co-authored-by: Birger J. Nordølum <[email protected]>
- Resolved presets referenced in config
- Repository config

The above is the order of precedence.
Copy link
Collaborator

Choose a reason for hiding this comment

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

Better layout

I think we should:

  1. Move the platform sentence about the "order of preference" to the top of the new numbered list.
  2. Convert the list to a numbered list.
  3. Say something like: "Items with a higher number override (or merge with) items that have lower numbers. If the item has the mergeable property, it will merge with lower numbers."

Mockup

Platform sentence.

  1. Item one
  2. Item two
  3. Item three, and so on

Explain how high numbers override or merge with low numbers.
Explain the mergeable property.
Explain where you can find the mergeable property.

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.

4 participants