Skip to content

Updates documentation to clarify #155.#167

Merged
jtdub merged 3 commits into
masterfrom
issue155
Dec 12, 2025
Merged

Updates documentation to clarify #155.#167
jtdub merged 3 commits into
masterfrom
issue155

Conversation

@jtdub

@jtdub jtdub commented Nov 17, 2025

Copy link
Copy Markdown
Contributor

closes #155

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Pull Request Overview

This PR adds clarifying documentation to explain the difference between HConfig.merge() and HConfig.future() methods, addressing issue #155. The documentation helps users understand when to use each method and what to expect from their behavior.

  • Adds a new section in future-config.md explaining the distinct purposes of merge() vs future()
  • Adds a note in custom-workflows.md explaining merge()'s strict behavior and when to use future() instead
  • Includes minor formatting fixes to code blocks

Reviewed Changes

Copilot reviewed 2 out of 2 changed files in this pull request and generated 2 comments.

File Description
docs/future-config.md Adds new section explaining merge() vs future(), clarifying that merge() is strict and raises DuplicateChildError for overlapping sections while future() allows overlapping configuration
docs/custom-workflows.md Adds contextual note about merge() behavior with link to future() documentation; updates code block syntax highlighting to text for output examples

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Comment thread docs/future-config.md Outdated
Comment thread docs/future-config.md Outdated
jtdub and others added 2 commits December 11, 2025 19:25
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
@jtdub
jtdub merged commit a8120a7 into master Dec 12, 2025
5 checks passed
@jtdub
jtdub deleted the issue155 branch December 12, 2025 01:27
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.

Merging configs does not properly merge children

2 participants