Rename types in preparation for TypeDoc #16
Merged
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
lolmaus
force-pushed
the
typedoc-rename
branch
from
121bfc3 to
1781d48
Compare
ef4
reviewed
Sep 12, 2023
| type: 'derived'; | ||
| parent: Scenarios; | ||
| variants: Record<string, ProjectMutator[]>; | ||
| }; |
There was a problem hiding this comment.
As we discussed on the office hours, this type is entirely private and self-contained so it should go back to being not exported.
If we add documentation to it, the most useful documentation would be on its individual fields. The object itself is really just an help to typescript so we know which fields are available in which states.
lolmaus
force-pushed
the
typedoc-rename
branch
from
1781d48 to
690329a
Compare
mansona
approved these changes
Oct 7, 2023
| * | ||
| * @returns A {@link Project} instance, optionally wrapped into a promise. | ||
| */ | ||
|
|
There was a problem hiding this comment.
Suggested change
shouldn't this comment block be "connected" to the following code for it to be picked up? or is it smart enough to know that it refers to the next line of code that isn't whitespace?
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.
This PR is in preparation for TypeDoc documentation.
This PR contains two changes:
rootcallbacks and properties tocallbackCreateProject. This makes them much more obvious, and also removes the ambiguity withrootfromProjectwhere it's a string.It also defines a type for the callback, as it's used in many places throughout the code.
And renames
ProjectMutatortype toCallbackMutateProjectfor consistency.Statetype intoScenariosStateRootandScenariosStateDerived. This lets me document them separately. TheScenraiosprefix scopes the type to its relevant class.