Skip to content

Build step should copy comments on types with a single method signature onto the actual method signature, too. #12812

@phryneas

Description

@phryneas

This is something for later, but I just noticed it so I'm opening a tracking issue.

For a type like

type RequestHandler = (operation: Operation, forward: NextLink) => Observable<FetchResult> | null;

we have an outer and an inner signature

/** OUTER */
type RequestHandler = /** INNER */ (operation: Operation, forward: NextLink) => Observable<FetchResult> | null;

and they show up on different moments of hover.

This is especially noticeable when writing code - once you type handler(, the popup shows only the inner comment, not the outer one, so users might lose a lot of useful documentation that way.

Long-term, our build step should probably duplicate comments from OUTER to the INNER position if there isn't already a comment.

See this example:

https://www.typescriptlang.org/play/?#code/JYWwDg9gTgLgBAbzgeTAUygQxsCA7AGjgDk0APGAGWDwGs4BfOAMyghDgHIABTSAG34QA9AGN+wNHhjCJdMdDScAUKEixEKAEYBnDADdMW-miIAxNDFEALAEpodAV37wmrdl14ChYiVJgqACZo4phQaHCi+DrwEOhYOPgAXCjx2LiELNAA7mGBKaQU1HQA3MrKCMpwcDAAnuhw9gCOjg4wABKYeIEmUHAAvFXVcMIAVKNDw6NwAJLExACitpPV0wCCcOEtbXDWXT0YcMA6mw6QeDrAxhHM0HDxt1AgNADmcDrsEUIvwKJw+3ByCFHDg8G8YNY0Cs4NMtq0YkQ0MAIYctLU4ABtR65KCBV4AXQAFNYYDAwDoksJhHwIIIIC8sGBrE1+AA6KIgYSBCCiHTCcKYUQyPjAWQ0WjCGgwNiBRxCjIAYhRAFo4W1lXtur0AJQ1SFwOIYdL4GoQPURPDkeByeg0c3Q6Y2TA0Ih3PTdV7mg1pRJ4U1e4IxGjGv0Q7CAsjAmAOI4wIhOGz-HQO-5wADijOsAEVKO8DBhWQ6U9wwGFMBxDQkMnBlXAACr6gAGqCNvsbBq0ACsQvAw-AwGx9MBA0c8I8QCH-loICD7cNVpFHFBwtJ+OigaIQWhAunMznTtsYoX5zDi6WsBxsXka3ANsxHHh5Sa+0cTqJMIJt-6N1uvZaKHANqjnO86OnsNDHqBwgrISlYhikLZVvgRBXriBRWsUtC6v0AB82h6FAhjXAAPBYVh2A4zgwHhAA+cB4M4-BlEMUQXPAmoHFAKTNPCHT7L0AyIEwmAnF0tRDFSJ5wAAersED6IckLhHAhKdo4MRwAARKxGkcb03FoIefFahgmnahJwhSVZ1myQCSkRKp6nwCAljWBAO6XC8eDYEuETZMibmzhyLnSOZ1R6RgsE+hkKE5Hk2plNUkm2d0uwYA5cyLLYkTsCFMDmQw5TlJUSXjJM0zIAAqnWSzlbeB68bs-GHMcpw6OclzXFkfQPNAzxgu8nyAfSvz-KlP6guCkJ1WqCKAgFqLolicW4gSxKkuSlLUt49KZiy7LsFyPJ8gKQrbaKNqStIMpyr6SqQqqhm8RqzVQLqKLeq21YwGaH3-ta4rASidVOi6Bp9O6eIDR9cG+v6H2BqCk4vhNMbIvGcrWEmdWYLufDZrmBEKVAkGnlMcAlmWFbRSatYNhEzY03g7YQF2PZ6uGA7ycOaNjn1k5GDOvbTeTm7Lv4a4RlGX4Zvj+6zTApMTOTlMXt1OI7rWd4Pk+oZ7PArXvp+O4-VLm7Rn+VqAYDdrA6L4F4Er0HVHUDQ8W0nQmX0-QqbDGQIUzsVQBr6FFOK2F4cgugGEYJikZYNj2E4Li0fRjHMdUOnsa9BlGZ7nGCQgwmiXg4lJZZJ6yW5xNpcpjkadp0TZ17ue8fnvRmRZ1nd-OKU7vZKlVTV2XBf4YVNV7UVfch6vxYlIyWX3tcOWpGkuRC7nvMAXk+cp-kb0FuVj8ohUVBJZXk0PtXkxsCsTwXrXhO10RXCY3X3Bg46eh8LnDT8fwAgmp6O2C4FaIgWn0NEmJUJQxeESEkZIKRUhpHSBk+N9ociOryfkaBBTCjABdcUV1pTuVuoqFUCsXpe3evqP2z5fr6n+tbOgQMRYLlBpkN0UhYFejoaGBhEREbBjhijSM5s0ZxneJjbG5NcayyZPuImBZyp1VVuWT6SE-R0ybIhEMLM2ZCg5v2QcPMTg0HHALacs4QEwkXOLVc64xFbh3PIgmDU2hK1UeedRMCbza0fCI-Wr5IgfhMCbM0qNLYASArbNhtiOFOyGK7CI7sYjt0OIMecYxlagVmPMa+uTb5PR2BFPoj8zgvy6o8D+UAv4DR-l8EaADxpOMmiBcmYD5ookgUtGBa0EGbWQTtNBTIMGHW5Ng06+DCHyClDdXW900CPSMlQziNCIh8Phowq2MS9ZQhPGBZ0nCIbcOAbQpmWzBFtGEd9IJqMzGSITFjESKY5F7kJvmEmRYDkU28dTaeWj6w6KZvo7shiXxcyHCOcx-M4aC2sXE9hS4VwwElqjFx7z3FHm+bktRl4Vqa3qveAJtzwyG1CV+U2kS-o7JtnslMCSHTO2GFPTRAcAVBxDiQDC4cBiR2joRWOaB47kSTlRVODFBAZxymxe++lGjFLSa9QuxcxplwXlJKu8lFLpRUqveAjdZWlNbh7V6ndy490tUvAehIr4jyPqFIYpTWUhk5XPLu1rdWEkyksHKIA8oFSAA

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions