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

Allow TS variables to be documented #111

Merged
merged 1 commit into from
May 7, 2018
Merged

Allow TS variables to be documented #111

merged 1 commit into from
May 7, 2018

Conversation

raymondfeng
Copy link
Member

@raymondfeng raymondfeng commented May 4, 2018

For example:

export namespace a {
  export const X = 1;
  export const Y = 2;
}

export const B = 'b';

Description

Related issues

Checklist

  • New tests added or existing tests modified to cover all changes
  • Code conforms with the style
    guide

expect(parsedData.constructs.map(function(c) {
return c.node.name;
})).to.eql(['param.Message', 'param.path',
'Greeter', 'PathParameterValues']);
'Greeter', 'PathParameterValues', 'greeter']);
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why do we also not check for the namespace param?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Namespace param has become a prefix for its members.

Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

So it's impossible to generate docs based on the api docs directly on top of the namespace currently, right?

@raymondfeng
Copy link
Member Author

@shimks I have improved how namespace is handled and now it's kept in the apidocs. PTAL.

For example:

export namespace a {
  export const X = 1;
  export const Y = 2;
}

export const B = 'b';
@raymondfeng raymondfeng merged commit ebf7539 into master May 7, 2018
@bajtos bajtos deleted the fix-variables branch May 9, 2018 10:57
@bajtos
Copy link
Member

bajtos commented May 9, 2018

This is awesome, thank you @raymondfeng 👏

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants