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

JSDoc in nested object not being exportet #21

Closed
SantoJambit opened this issue Dec 11, 2020 · 2 comments
Closed

JSDoc in nested object not being exportet #21

SantoJambit opened this issue Dec 11, 2020 · 2 comments
Assignees
Labels
bug Something isn't working

Comments

@SantoJambit
Copy link
Contributor

This is happening in piral 0.12.4, which uses dets 0.9.2:

/**
 * Object description
 * @see exampleExport2
 */
export const exampleExport = {
    /**
     * Some description
     * @param key some param
     */
    start(key: string) {
        return key;
    },
};

Output:

  /**
   * Object description
   * @see exampleExport2
   */
  export const exampleExport: {
    start(key: string): string;
  };

I saw some work was done in #19, but this seems to be a special case that slipped through the tests.

@FlorianRappl
Copy link
Owner

Yeah good point. Its not too late for a 0.9.3 that goes into Piral 1.0.

Let me see how quickly that can be done.

Thanks!

@FlorianRappl FlorianRappl added the bug Something isn't working label Dec 11, 2020
@FlorianRappl FlorianRappl self-assigned this Dec 11, 2020
FlorianRappl added a commit that referenced this issue Dec 11, 2020
@FlorianRappl
Copy link
Owner

Fix landed in develop. 0.9.3 about to be released.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working
Projects
None yet
Development

No branches or pull requests

2 participants