adobe / adobe/aio-lib-photoshop-api
Mark FileResolver as @private so it's not part of the generated docs
- Dominant language
- JavaScript
- Stars
- 27
- Forks
- 14
- PR merge metrics
- No merged PRs in 30d
Description
FileResolver is mostly meant to be used internally, however initially I thought it might give some idea how urls/filenames are resolved by the API. Looking at the generated documentation now, and also https://github.com/adobe/asset-compute-example-workers/pull/29/files, I realize that it is misleading and clients may be calling directly before calling the Photoshop API.
I think the class should be marked with `@private` so the documentation is no longer generated.
Contributor guide
Research direction
Find the FileResolver class and check how its documentation is generated. Mark it with `@private`; done means the class no longer appears in the generated documentation.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- javascript
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 1/5
- Estimated time
- Under an hour
- Activity status
- Stale
- Clarity
- Clearly specified
- Newbie friendliness
- 35/100