-
Notifications
You must be signed in to change notification settings - Fork 676
docs: add generated reference files #2313
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
Conversation
Codecov ReportAll modified and coverable lines are covered by tests ✅
✅ All tests successful. No failed tests found. Additional details and impacted files@@ Coverage Diff @@
## main #2313 +/- ##
=======================================
Coverage 92.74% 92.74%
=======================================
Files 38 38
Lines 10660 10660
Branches 687 687
=======================================
Hits 9887 9887
Misses 761 761
Partials 12 12
Flags with carried forward coverage won't be shown. Click here to find out more. 🚀 New features to boost your workflow:
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@lukegalbraithrussell LGTM! And an incredible thanks for tackling this.
With quick reading this all is so solid but I remain open to follow ups as needed for both jsdoc
and file organization alike. For now I think it'd be awesome to ship this 🚢 💨
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
👁️🗨️ Unrelated to this PR, but this file makes it clear that keeping dependencies at the latest versions is meaningful for reference.
A change landed in @slack/[email protected]
that updated this from team_domain_changed
to be the expected team_domain_change
event and at the moment @slack/web-api
uses:
"@slack/types": "^2.9.0", |
const SlackProduct: object; | ||
``` | ||
|
||
Defined in: [utils/constants.ts:52](https://github.com/slackapi/node-slack-sdk/blob/main/packages/cli-test/src/utils/constants.ts#L52) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
👁️🗨️ This link might be finding main
instead of a specific commit, though I do think we can revisit this for neartime releases!
Edit: Added relevant typedoc
configs following 🔍
node-slack-sdk/packages/cli-test/typedoc.json
Lines 15 to 16 in 22117c2
"gitRevision": "main", | |
"includeVersion": true, |
Summary
This is a follow up to #2308 . adds the actual reference files by deleting the line in .gitignore
Requirements (place an
x
in each[ ]
)