added documentation comments to the storybook elements of the app #70
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
jjoel1630
reviewed
Jan 9, 2025
| * | ||
| * @typedef {Object} MCAPFileInformationNew | ||
| * @property {string} id - A unique identifier for the event. | ||
| * @property {Array<{file_name: string, signed_url: string}>} mcap_files - A list of MCAP files related to the event. Each file is represented by its name and a signed URL to access the file. |
There was a problem hiding this comment.
In our index.d.ts file we have a type called FileType. I think it would be easier to say that mcap_files is an Array.
jjoel1630
reviewed
Jan 9, 2025
| * @typedef {Object} MCAPFileInformationNew | ||
| * @property {string} id - A unique identifier for the event. | ||
| * @property {Array<{file_name: string, signed_url: string}>} mcap_files - A list of MCAP files related to the event. Each file is represented by its name and a signed URL to access the file. | ||
| * @property {Array<{file_name: string, signed_url: string}>} mat_files - A list of MAT files associated with the event. Similar to `mcap_files`, each MAT file has a file name and signed URL. |
There was a problem hiding this comment.
Same thing for mat_files
jjoel1630
reviewed
Jan 9, 2025
| * @property {string} id - A unique identifier for the event. | ||
| * @property {Array<{file_name: string, signed_url: string}>} mcap_files - A list of MCAP files related to the event. Each file is represented by its name and a signed URL to access the file. | ||
| * @property {Array<{file_name: string, signed_url: string}>} mat_files - A list of MAT files associated with the event. Similar to `mcap_files`, each MAT file has a file name and signed URL. | ||
| * @property {Array<{content: string, signed_url: string}>} content_files - A list of content files, each having a name (`content`) and a signed URL for access. |
There was a problem hiding this comment.
I believe we have a type called ContentFileType, so maybe saying Array is better?
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
No description provided.