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

typedocs are strange for configuration #22

Open
bobheadxi opened this issue Apr 19, 2020 · 0 comments
Open

typedocs are strange for configuration #22

bobheadxi opened this issue Apr 19, 2020 · 0 comments
Labels
blocked Work cannot begin on this documentation Improvements or additions to documentation

Comments

@bobheadxi
Copy link
Member

bobheadxi commented Apr 19, 2020

Frustratingly, this code:

export const clubConfig: {
  memberCount: number;
  currentTeams: Team[];
  featuredTeams: Team[];
} = {
  /**
   * The current or most recent active Launch Pad teams and their primary project.
   * 
   * Each element must satisfy [[`Team`]].
   */
  currentTeams: [ ... ]

generates the documentation without taking into account currentTeams: Team[]:

image

see https://ubclaunchpad.com/config/

I'm pretty sure this is a bug on typedoc's end: TypeStrong/typedoc#958 (I added this generator in #21 )

To do: either keep an eye typedoc, or find another tool to generate /config

@bobheadxi bobheadxi added the documentation Improvements or additions to documentation label Apr 19, 2020
@bobheadxi bobheadxi self-assigned this Apr 19, 2020
@bobheadxi bobheadxi added the blocked Work cannot begin on this label Apr 21, 2020
@bobheadxi bobheadxi changed the title typedocs are strange for const variables typedocs are strange for configuration Apr 21, 2020
@bobheadxi bobheadxi removed their assignment Dec 15, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
blocked Work cannot begin on this documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

1 participant