[Event Hubs] Fix remaining TSDoc linting errors #13746
Merged
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
ramya-rao-a
requested review from
chradek,
HarshaNalluru and
richardpark-msft
as code owners
ghost
added
the
HarshaNalluru
approved these changes
Feb 11, 2021
ramya-rao-a
commented
Feb 11, 2021
| @@ -9,8 +9,8 @@ import { parseConnectionString } from "@azure/core-amqp"; | |||
| export interface EventHubConnectionStringProperties { | |||
| /** | |||
| * The fully qualified Event Hub namespace extracted from the "Endpoint" in the | |||
| * connection string. This is likely to be similar to "{yournamespace}.servicebus.windows.net". | |||
| * This is typically used to construct the EventHub{Producer|Consumer}Client. | |||
| * connection string. This is likely to be similar to "\{yournamespace\}.servicebus.windows.net". | |||
There was a problem hiding this comment.
@deyaaeldeen Is this the recommended way to get past the error from tsdoc linter on malformed tags?
There was a problem hiding this comment.
I do not remember if I have seen this before but I think if you enclose it in `` instead of "" the error will go away. If not, perhaps try <> instead of {}.
There was a problem hiding this comment.
Ah, backtick works! Updated in e97da9e
|
Hello @ramya-rao-a! Because this pull request has the p.s. you can customize the way I help with merging this pull request, such as holding this pull request until a specific person approves. Simply @mention me (
|
ghost
merged commit
This pull request was closed.
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 the remaining TSDoc related linting errors in Event Hubs, thereby reducing the number of total linter problems from 70 to 38. Related to #12953 and #10777
@chradek Of the 38, errors are 18 and warnings are 20. Handing over the rest to your capable hands!