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.

Sign up for GitHub

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

Jump to bottom

Docs/update descriptor method ref #942

Merged
merged 4 commits into from
Jun 5, 2024
Merged

Docs/update descriptor method ref #942

merged 4 commits into from
Jun 5, 2024

Conversation

wrerwin
Copy link
Contributor

@wrerwin wrerwin commented Jun 5, 2024 •
edited
Loading

Citrine Python PR

Description

Small fix in the narrative docs where references to the deprecated DescriptorMethods.descriptors_from_data_source() is replaced by the current method DescriptorMethods.from_data_source().

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

wrerwin added 4 commits June 5, 2024 13:06
@wrerwin
updated deprecated references DescriptorMethods.descriptors_from_data…
95e8cb8 
…_source to reflect DescriptorMethods.from_data_source
@wrerwin
updated deprecated references DescriptorMethods.descriptors_from_data…
6be08b6 
…_source to reflect DescriptorMethods.from_data_source
@wrerwin
bumped minor version
574f3f0
@wrerwin
Merge remote-tracking branch 'origin/docs/update_descriptor_method_re…
365c230 
…f' into docs/update_descriptor_method_ref

rebasing
@wrerwin wrerwin requested a review from jspeerless June 5, 2024 20:24
jspeerless
jspeerless approved these changes Jun 5, 2024
View reviewed changes
Copy link
Collaborator

@jspeerless jspeerless left a comment

Choose a reason for hiding this comment

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

LGTM!

@jspeerless jspeerless merged commit 8f57fee into main Jun 5, 2024
16 checks passed
@jspeerless jspeerless deleted the docs/update_descriptor_method_ref branch June 5, 2024 20:29
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@jspeerless jspeerless jspeerless approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@wrerwin @jspeerless