docs: improve types #288
Merged
docs: improve types #288
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
erickzhao
commented
Jun 11, 2024
| */ | ||
| export async function downloadArtifact( | ||
| _artifactDetails: ElectronPlatformArtifactDetailsWithDefaults, | ||
| artifactDetails: ElectronPlatformArtifactDetailsWithDefaults | ElectronGenericArtifactDetails, |
There was a problem hiding this comment.
Doesn't make sense to have the function parameter start with _ so I changed the variable naming around.
|
|
||
| return await cache.putFileInCache(url, tempDownloadPath, fileName); | ||
| }); | ||
| } | ||
|
|
||
| /** | ||
| * Downloads a specific version of Electron and returns an absolute path to a | ||
| * Downloads the Electron binary for a specific version and returns an absolute path to a | ||
| * ZIP file. |
There was a problem hiding this comment.
Technically, we have some non-ZIP artifacts too as well? such as SHASUM256.txt
erickzhao
force-pushed
the
typedoc-improvements
branch
2 times, most recently
from
66af0cc
to
8e3a343
Compare
georgexu99
approved these changes
Jun 21, 2024
|
🎉 This PR is included in version 3.1.0 🎉 The release is available on: Your semantic-release bot 📦🚀 |
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.
Cleanup of our API documentation for
@electron/get.Notable changes:
ElectronGenericArtifactDetailsout ofElectronPlatformArtifactDetailsWithDefaults.Other work is mostly categorizing, expanding on existing comments, and hiding internal types.