Skip to content

Conversation

@dixonjoel
Copy link
Collaborator

What does this Pull Request accomplish?

Updates the reference documentation to match the latest in the Python APIs

Why should this Pull Request be merged?

Accurate documentation. Also, there's a desire to have conceptual documentation for the Measurement Data Services ecosystem, so this could be a starting point for that.

What testing has been done?

Docs

@dixonjoel dixonjoel requested a review from csjall as a code owner January 13, 2026 15:38
Copilot AI review requested due to automatic review settings January 13, 2026 15:38
Copy link
Contributor

Copilot AI left a comment

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 updates the reference documentation to align with the latest Python API changes in the Measurement Data Services ecosystem. The updates modernize the API interface by moving types to public modules, simplifying parameter names, and clarifying enum values.

Changes:

  • Updated import statements to use public API modules instead of internal _types modules
  • Renamed API parameters for consistency (extensionsextension, measurement_namename, field-specific names consolidated to name)
  • Simplified method signatures (e.g., create_alias now takes positional parameters instead of keyword arguments)
  • Updated enum values to remove redundant prefixes (e.g., Outcome.OUTCOME_PASSEDOutcome.PASSED)
  • Renamed field identifiers for clarity (data_typevalue_type, typestep_type/condition_type)
  • Enhanced data type documentation with more specific type names

Reviewed changes

Copilot reviewed 3 out of 3 changed files in this pull request and generated 1 comment.

File Description
docs/reference/using-measurement-data-services.md Updated all code examples to use the latest API signatures, including imports, parameter names, enum values, and query syntax
docs/reference/ni-metadata-store.md Updated field documentation to reflect renamed parameters (extension, name fields) and improved structure with "Core Entities" section
docs/reference/ni-data-store.md Updated field documentation and data type descriptions to match current API, clarified enum values and type nomenclature

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

@dixonjoel dixonjoel enabled auto-merge (squash) January 14, 2026 16:01
@dixonjoel dixonjoel merged commit ec6bc6e into main Jan 16, 2026
29 checks passed
@dixonjoel dixonjoel deleted the users/jdixon/update-conceptual-docs branch January 16, 2026 18:37
@dixonjoel
Copy link
Collaborator Author

@csjall I'm curious if you've read these in detail whether you think it would be at least a good starting point for language-agnostic conceptual documentation for MDS.

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