docs: Fix spec objects parameter definitions #2024
Merged
+67
−25
Conversation
This file contains 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
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #2024 +/- ##
=======================================
Coverage 97.11% 97.11%
=======================================
Files 239 239
Lines 41066 41108 +42
=======================================
+ Hits 39880 39922 +42
Misses 1186 1186
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Sentry. |
svetlanabrennan
approved these changes
Feb 16, 2024
jsumners-nr
added a commit
to jsumners-nr/node-newrelic
that referenced
this pull request
Feb 16, 2024
jsumners-nr
added a commit
to jsumners-nr/node-newrelic
that referenced
this pull request
Feb 16, 2024
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.
This PR fixes some issues with the docs on the recently added spec objects. When I got to some specs that only add one or two parameters to the subclass I forgot why I was using a
typedeffor the constructor parameters and wrote them inline. This was a mistake. Each subclass's parameters should augment the parent class's parameters. We can only do that withtypedefblocks for the parameters.As I was fixing this issue, I discovered that the
@augmentstag does not inline the parent definition's properties, nor provide a link back to the definition. The@mixestag at least provides a link.