[Documentation] Document Limit Evaluators#8336
Open
DakshUbhadia wants to merge 1 commit into
Open
Conversation
Expands Limit Evaluator documentation in API.md and adds TSDoc for the LimitViolation object in telemetryAPI.js. This ensures consistency between the API documentation and source code. Addresses nasa#8165
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Closes #8165
Describe your changes:
Expands Limit Evaluator documentation in
API.mdand adds TSDoc for theLimitViolationobject intelemetryAPI.js. This ensures consistency between the API documentation and source code.Testing Instructions:
API.mdandtelemetryAPI.js.API.md.telemetryAPI.js.npm run lintandnpm testto ensure no build regressions (verified locally).(Note to reviewers: I have just emailed my signed Individual CLA as this is my first contribution).
All Submissions:
Author Checklist
type:label? Note: this is not necessarily the same as the original issue.Reviewer Checklist