Skip to content

Update Docs#972

Merged
jspeerless merged 3 commits into
mainfrom
doc_update
Nov 8, 2024
Merged

Update Docs#972
jspeerless merged 3 commits into
mainfrom
doc_update

Conversation

@jspeerless

Copy link
Copy Markdown
Collaborator

Update header for dataset sharing

Citrine Python PR

Description

Minor updates to documentation to

  • Correct mention of projects in sharing
  • Add instructions for release notes (deleted from Confluence)

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

Update header for dataset sharing
Include Release Notes Template
@jspeerless jspeerless changed the title Update datasets.rst Update Docs Nov 8, 2024
@jspeerless jspeerless marked this pull request as ready for review November 8, 2024 14:56
@jspeerless jspeerless requested a review from a team as a code owner November 8, 2024 14:56

@ventura-rivera ventura-rivera 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.

lgtm!

@jspeerless jspeerless merged commit baf7fdc into main Nov 8, 2024
@jspeerless jspeerless deleted the doc_update branch November 8, 2024 15:06
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.

3 participants