-
Notifications
You must be signed in to change notification settings - Fork 1
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
added documentation comments to the storybook elements of the app #70
Open
kaisernarkotic
wants to merge
1
commit into
main
Choose a base branch
from
storybook-docs
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
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
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,8 +1,25 @@ | ||
/** | ||
* Represents the list of event types. | ||
* | ||
* These are predefined categories used to describe different types of automotive events. | ||
* This constant can be used in forms, filters, or data validation in Storybook components. | ||
*/ | ||
export const eventType: string[] = [ | ||
"Acceleration", | ||
"Endurance", | ||
"Skidpad", | ||
"Autocross", | ||
"Acceleration", // Event type for acceleration tests. | ||
"Endurance", // Event type for endurance tests. | ||
"Skidpad", // Event type for skidpad tests. | ||
"Autocross", // Event type for autocross tests. | ||
]; | ||
|
||
export const location: string[] = ["MRDC", "Michigan", "Rome", "SCC"]; | ||
/** | ||
* Represents the list of possible locations. | ||
* | ||
* These are predefined locations where events have occurred. | ||
* This constant can be used for filtering data or displaying location options in Storybook components. | ||
*/ | ||
export const location: string[] = [ | ||
"MRDC", // Location for the MRDC event. | ||
"Michigan", // Location for the Michigan event. | ||
"Rome", // Location for the Rome event. | ||
"SCC", // Location for the SCC event. | ||
]; |
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,3 +1,18 @@ | ||
/** | ||
* Represents information about an MCAP (Model, Configuration, and Analysis Protocol) file and its associated data. | ||
* Each entry in the array corresponds to a specific event, containing metadata about files, content, and event details. | ||
* | ||
* @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. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Same thing for mat_files |
||
* @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. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. I believe we have a type called ContentFileType, so maybe saying Array is better? |
||
* @property {string} date - The date when the event occurred, formatted as MM-DD-YYYY. | ||
* @property {string} location - The location where the event took place. | ||
* @property {string} notes - Additional notes or comments about the event. | ||
* @property {string} event_type - The type of event (e.g., "acceleration", "endurance"). | ||
* @property {Object} schema - An object containing versioning information for the event's schema. Each schema property represents a version string. | ||
*/ | ||
export const data: MCAPFileInformationNew[] = [ | ||
{ | ||
id: "505deb4b-44a8-48dd-9da6-a671c1d3eccd", | ||
|
Oops, something went wrong.
Oops, something went wrong.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
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.