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.

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

docs: Mission Status and more #7521

Merged
merged 11 commits into from
Mar 26, 2024
Merged

docs: Mission Status and more #7521

merged 11 commits into from
Mar 26, 2024

Conversation

ozyx
Copy link
Contributor

@ozyx ozyx commented Feb 23, 2024

Closes #7520

Describe your changes:

Updates JSDoc types and documents the Mission Status feature. Also adds some docs for User API and UserIndicator where appropriate.

Updates primitive types in JSDocs to be lowercase (string, number), and non-primitive to be uppercase (Object)

All Submissions:

  • Have you followed the guidelines in our Contributing document?
  • Have you checked to ensure there aren't other open Pull Requests for the same update/change?
  • Is this a notable change that will require a special callout in the release notes Notable Change ? For example, will this break compatibility with existing APIs or projects which source these plugins?

Author Checklist

  • Changes address original issue?
  • Tests included and/or updated with changes?
  • Has this been smoke tested?
  • Have you associated this PR with a type: label? Note: this is not necessarily the same as the original issue.
  • Have you associated a milestone with this PR? Note: leave blank if unsure.
  • Is this a breaking change to be called out in the release notes?
  • Testing instructions included in associated issue OR is this a dependency/testcase change?

Reviewer Checklist

  • Changes appear to address issue?
  • Reviewer has tested changes by following the provided instructions?
  • Changes appear not to be breaking changes?
  • Appropriate automated tests included?
  • Code style and in-line documentation are appropriate?

@ozyx ozyx added type:maintenance tests, chores, or project maintenance type:docs updates to documentation labels Feb 23, 2024
@ozyx ozyx added this to the Target:4.0.0 milestone Feb 23, 2024
"module": "esnext",
"moduleResolution": "node",
"outDir": "dist",
"skipLibCheck": true,
"target": "ES2015",
Copy link
Contributor Author

Choose a reason for hiding this comment

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

Target modern ES with our Typescript type generation

ViewRegistry.prototype.get = function (item, objectPath) {
if (objectPath === undefined) {
throw 'objectPath must be provided to get applicable views for an object';
export default class ViewRegistry extends EventEmitter {
Copy link
Contributor Author

Choose a reason for hiding this comment

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

Conversion to ES6 class

Copy link

codecov bot commented Feb 23, 2024

Codecov Report

Attention: Patch coverage is 86.66667% with 4 lines in your changes are missing coverage. Please review.

Project coverage is 55.15%. Comparing base (dc9bd8b) to head (634aeef).

Additional details and impacted files
@@            Coverage Diff             @@
##           master    #7521      +/-   ##
==========================================
- Coverage   55.43%   55.15%   -0.28%     
==========================================
  Files         672      672              
  Lines       26961    26956       -5     
  Branches     2620     2620              
==========================================
- Hits        14946    14868      -78     
- Misses      11297    11368      +71     
- Partials      718      720       +2     
Flag Coverage Δ
e2e-full 21.66% <83.33%> (-19.56%) ⬇️
e2e-stable 59.49% <86.66%> (+0.20%) ⬆️
unit 48.45% <86.66%> (-0.04%) ⬇️
Files Coverage Δ
openmct.js 100.00% <ø> (ø)
src/MCT.js 97.00% <ø> (ø)
src/api/Branding.js 75.00% <ø> (ø)
src/api/annotation/AnnotationAPI.js 90.14% <ø> (-1.41%) ⬇️
src/api/composition/CompositionCollection.js 93.58% <ø> (ø)
src/api/faultmanagement/FaultManagementAPI.js 81.81% <ø> (ø)
src/api/forms/FormsAPI.js 94.87% <ø> (ø)
src/api/menu/MenuAPI.js 92.00% <ø> (ø)
src/api/notifications/NotificationAPI.js 98.83% <ø> (ø)
src/api/objects/InMemorySearchProvider.js 94.44% <ø> (ø)
... and 36 more

... and 6 files with indirect coverage changes


Continue to review full report in Codecov by Sentry.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update dc9bd8b...634aeef. Read the comment docs.

Copy link
Contributor

@charlesh88 charlesh88 left a comment

Choose a reason for hiding this comment

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

From a non-technical, looking-at-copy point of view: LGTM.

@ozyx ozyx added the pr:e2e:couchdb npm run test:e2e:couchdb label Mar 22, 2024
@ozyx ozyx enabled auto-merge (squash) March 22, 2024 17:04
@ozyx ozyx disabled auto-merge March 26, 2024 18:15
@ozyx ozyx force-pushed the docs-mission-status-and-more branch from 634aeef to 57a3d90 Compare March 26, 2024 18:21
@ozyx ozyx force-pushed the docs-mission-status-and-more branch from 57a3d90 to c5fcc79 Compare March 26, 2024 18:22
@codecov-commenter
Copy link

codecov-commenter commented Mar 26, 2024

Codecov Report

Attention: Patch coverage is 86.66667% with 4 lines in your changes are missing coverage. Please review.

Project coverage is 55.15%. Comparing base (986da57) to head (634aeef).

❗ Current head 634aeef differs from pull request most recent head c5fcc79. Consider uploading reports for the commit c5fcc79 to get more accurate results

Additional details and impacted files
@@            Coverage Diff             @@
##           master    #7521      +/-   ##
==========================================
- Coverage   56.31%   55.15%   -1.16%     
==========================================
  Files         672      672              
  Lines       27119    26956     -163     
  Branches     2632     2620      -12     
==========================================
- Hits        15272    14868     -404     
+ Misses      11519    11368     -151     
- Partials      328      720     +392     
Flag Coverage Δ
e2e-full 21.66% <83.33%> (-1.91%) ⬇️
e2e-stable 59.49% <86.66%> (-0.87%) ⬇️
unit 48.45% <86.66%> (-0.63%) ⬇️
Files Coverage Δ
openmct.js 100.00% <ø> (ø)
src/MCT.js 97.00% <ø> (ø)
src/api/Branding.js 75.00% <ø> (ø)
src/api/annotation/AnnotationAPI.js 90.14% <ø> (ø)
src/api/composition/CompositionCollection.js 93.58% <ø> (ø)
src/api/faultmanagement/FaultManagementAPI.js 81.81% <ø> (-9.10%) ⬇️
src/api/forms/FormsAPI.js 94.87% <ø> (ø)
src/api/menu/MenuAPI.js 92.00% <ø> (ø)
src/api/notifications/NotificationAPI.js 98.83% <ø> (ø)
src/api/objects/InMemorySearchProvider.js 94.44% <ø> (ø)
... and 36 more

... and 264 files with indirect coverage changes


Continue to review full report in Codecov by Sentry.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 986da57...c5fcc79. Read the comment docs.

@ozyx ozyx enabled auto-merge (squash) March 26, 2024 18:24
@ozyx ozyx added pr:e2e:couchdb npm run test:e2e:couchdb and removed pr:e2e:couchdb npm run test:e2e:couchdb labels Mar 26, 2024
@github-actions github-actions bot removed the pr:e2e:couchdb npm run test:e2e:couchdb label Mar 26, 2024
@ozyx ozyx merged commit 6e26451 into master Mar 26, 2024
22 checks passed
@ozyx ozyx deleted the docs-mission-status-and-more branch March 26, 2024 19:11
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
type:docs updates to documentation type:maintenance tests, chores, or project maintenance
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Document Mission Status feature
4 participants