AdobeDocs / AdobeDocs/uxp

Unclear `Promise` types in `Clipboard.md`

Open
#74 0 comments 0 reactions 0 assignees View on GitHub
Dominant language
JavaScript
Stars
20
Forks
10
PR merge metrics
No merged PRs in 30d

Description

Promises have to be for/of some type (that type can be `void`). This type should be explicityly mentioned (e.g., `Promise`, `Promise`, etc.)

- https://github.com/AdobeDocs/uxp/blob/47510097aaf62876dfe00a01e00461ce5018e6cc/src/pages/uxp/reference-js/Global%20Members/Data%20Transfers/Clipboard.md?plain=1#L19-L23
- https://github.com/AdobeDocs/uxp/blob/47510097aaf62876dfe00a01e00461ce5018e6cc/src/pages/uxp/reference-js/Global%20Members/Data%20Transfers/Clipboard.md?plain=1#L37-L41
- https://github.com/AdobeDocs/uxp/blob/47510097aaf62876dfe00a01e00461ce5018e6cc/src/pages/uxp/reference-js/Global%20Members/Data%20Transfers/Clipboard.md?plain=1#L50-L53
- https://github.com/AdobeDocs/uxp/blob/47510097aaf62876dfe00a01e00461ce5018e6cc/src/pages/uxp/reference-js/Global%20Members/Data%20Transfers/Clipboard.md?plain=1#L69-L72
- https://github.com/AdobeDocs/uxp/blob/47510097aaf62876dfe00a01e00461ce5018e6cc/src/pages/uxp/reference-js/Global%20Members/Data%20Transfers/Clipboard.md?plain=1#L88-L91
- https://github.com/AdobeDocs/uxp/blob/47510097aaf62876dfe00a01e00461ce5018e6cc/src/pages/uxp/reference-js/Global%20Members/Data%20Transfers/Clipboard.md?plain=1#L102-L105
- https://github.com/AdobeDocs/uxp/blob/47510097aaf62876dfe00a01e00461ce5018e6cc/src/pages/uxp/reference-js/Global%20Members/Data%20Transfers/Clipboard.md?plain=1#L116-L120

_Originally posted by @pklaschka in https://github.com/AdobeDocs/uxp/pull/61#discussion_r997095368_

Contributor guide

Open the contributing guide

Research direction

Open src/pages/uxp/reference-js/Global Members/Data Transfers/Clipboard.md and inspect the Promise return types at the linked lines. Determine the appropriate explicit type for each documented method, then update all seven references and review the rendered Markdown for consistent signatures.

Written by the indexing model from the issue text.

Assessment

Tech stack
javascript
Domain
documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Clearly specified
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.