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

Misleading statement in "Usage" docs #1175

Closed
caxon opened this issue May 14, 2024 · 1 comment · Fixed by #1176
Closed

Misleading statement in "Usage" docs #1175

caxon opened this issue May 14, 2024 · 1 comment · Fixed by #1176
Labels
bug Something isn't working

Comments

@caxon
Copy link
Contributor

caxon commented May 14, 2024

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

  • Docs version: 2.3 and latest
@caxon caxon added the bug Something isn't working label May 14, 2024
@caxon
Copy link
Contributor Author

caxon commented May 14, 2024

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

#1176

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant