docs: document utility functions #13367
Merged
Conversation
This file contains hidden or 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
🦋 Changeset detectedLatest commit: c305ef2 The changes in this PR will be included in the next version bump. Not sure what this means? Click here to learn what changesets are. Click here if you're a maintainer who wants to add another changeset to this PR |
github-actions
bot
added
the
pkg: astro
ematipico
force-pushed
the
docs/asset-utils
branch
from
5349dd8 to
66bbeb4
Compare
CodSpeed Performance ReportMerging #13367 will not alter performanceComparing Summary
|
ArmandPhilippot
approved these changes
Mar 6, 2025
| } | ||
|
|
||
| const { width, height, type, orientation } = result; | ||
| const isPortrait = (orientation || 0) >= 5; |
There was a problem hiding this comment.
Maybe it's just my lack of knowledge, but why 5? Shouldn't there be a comment to explain this number?
There was a problem hiding this comment.
I agree with you, however I don't know the code either. Maybe @Princesseuh knows
Co-authored-by: Armand Philippot <[email protected]>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
Changes
This PR adds more JsDoc to the utility functions that we expose for image services.
I used a LLM tool to generate the docs, and then reviewed them to make sure they seem correct.
I also noticed
resolveSrcwas awaiting twice the same resource in case no.defaultwasn't returned. I changed the code so the awaiting is done once every time.I also slightly refactored
imageMetadatabecause we were throwing an error inside atryblock.Testing
CI should stay green
Docs
/cc @withastro/maintainers-docs for feedback!