Skip to content

HDS Doc updates#1025

Merged
anoto-moniz merged 5 commits intomainfrom
hds-docs
Mar 4, 2026
Merged

HDS Doc updates#1025
anoto-moniz merged 5 commits intomainfrom
hds-docs

Conversation

@jspeerless
Copy link
Collaborator

Citrine Python PR

Description

Document usage of hierarchical design spaces

PR Type:

  • Breaking change (fix or feature that would cause existing functionality to change)
  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Maintenance (non-breaking change to assist developers)

Adherence to team decisions

  • I have added tests for 100% coverage
  • I have written Numpy-style docstrings for every method and class.
  • I have communicated the downstream consequences of the PR to others.
  • I have bumped the version in __version__.py

Expanded documentation on hierarchical design spaces, including definitions, node structures, and examples of creating a design space for coatings.
@jspeerless jspeerless requested a review from a team as a code owner March 3, 2026 22:27
Copy link
Collaborator

Choose a reason for hiding this comment

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

I didn't even think about it requiring you to bump the version. That seems ugly to me. I'd advocate we make an exception to the version bump requirement here, especially since it's a doc, and thus doesn't interact with the logical code at all.

@kroenlein @jspeerless What do you think?

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

I would rather release 4.0.0 - I just was trying to follow the rules. I can revert.

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Is there a way to override the PR check @anoto-moniz ?

Copy link
Collaborator

Choose a reason for hiding this comment

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

I'm an admin, so I can admin merge it. The code looks good to me, and all the tests pass, so I'll do that now.

@jspeerless jspeerless requested a review from anoto-moniz March 4, 2026 16:25
@anoto-moniz anoto-moniz merged commit 8207261 into main Mar 4, 2026
37 of 38 checks passed
@anoto-moniz anoto-moniz deleted the hds-docs branch March 4, 2026 17:57
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.

2 participants