search

omry / omegaconf

Flexible Python configuration system. The last one you will ever need.
BSD 3-Clause "New" or "Revised" License
1.88k stars 98 forks source link

Misleading statement in "Usage" docs #1175

Closed caxon closed 1 month ago

caxon commented 2 months ago

Describe the bug In the Usage docs -> omegaconf-merge section: link to docs

The tutorial says:

"Note how the port changes to 82, and how the users lists are combined."

However, after testing it seems that merging lists are not combined and replaced instead with the list from the last specified config.

See a 2020 Stack Overflow response from Omry about list merging behavior - the lists used to get merged, but now they are simply replaced: link to SO

This line confused me as a new user of omegaconf. Can you remove the line about "how the users lists are combined".

The example also does not specify multiple users lists, so the example inputs are consistent with the example outputs.

To Reproduce N/A

Expected behavior Updated line in docs. See description above.

Additional context

caxon commented 2 months ago

I opened a minor PR (1 docs sentence changed), which fixes this.

https://github.com/omry/omegaconf/pull/1176