Skip to content
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

Parameter names using Finnish notation (trailing $) are not supported #140

Closed
CarstenLeue opened this issue Jan 28, 2019 · 3 comments
Closed
Labels
bug Something isn't working as intended effort: easy Probably a quick fix. Want to contribute? :-) help wanted If you're looking to contribute, this issue is a good place to start!

Comments

@CarstenLeue
Copy link

The following function declaration:

/**
 * Doc of my exported function
 *
 * @param aParam - first parameter
 * @param aObs$ - second parameter
 * @returns the return value
 */
export function myFunction(aParam: string, aObs$: Observable<string>): string {
  return '';
}

causes the "aObs$" parameter to not be recognized. On https://microsoft.github.io/tsdoc/# the second parameter is not documented, but will be documented when I leave out the trailing $.

Trailing $ names are common in Finnish notation to document observables.

This is related to microsoft/rushstack#1055

@octogonz
Copy link
Collaborator

This should be a pretty easy fix in _parseParamBlock().

@octogonz octogonz added bug Something isn't working as intended help wanted If you're looking to contribute, this issue is a good place to start! effort: easy Probably a quick fix. Want to contribute? :-) labels Jan 28, 2019
@octogonz
Copy link
Collaborator

@CarstenLeue here's a PR: #141

@octogonz
Copy link
Collaborator

Fixed in @microsoft/tsdoc@0.12.5

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working as intended effort: easy Probably a quick fix. Want to contribute? :-) help wanted If you're looking to contribute, this issue is a good place to start!
Projects
None yet
Development

No branches or pull requests

2 participants