Preview v5: Add explanation that individual initialisation will throw errors #352
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
✅ Deploy Preview for govuk-frontend-docs-preview ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
romaricpascal
force-pushed
the
document-errors
branch
from
cf96400 to
8c770a2
Compare
romaricpascal
force-pushed
the
document-errors
branch
2 times, most recently
from
596c0b1 to
8e522c3
Compare
romaricpascal
force-pushed
the
document-errors
branch
2 times, most recently
from
760452a to
8708ed7
Compare
romaricpascal
force-pushed
the
document-errors
branch
from
8708ed7 to
911cfa3
Compare
romaricpascal
force-pushed
the
document-errors
branch
from
911cfa3 to
1d0b2ae
Compare
colinrotherham
approved these changes
Oct 2, 2023
Co-authored-by: Colin Rotherham <colin.rotherham@digital.cabinet-office.gov.uk>
romaricpascal
force-pushed
the
document-errors
branch
from
1d0b2ae to
68fa05d
Compare
|
@colinrotherham Cheers! Updated. |
|
Looks good to me |
romaricpascal
changed the title
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.
As we decided that to start with, we’d limit our public API to “we throw errors”, we don’t have any specific errors to document as part of our JavaScript API Reference.
I think we don't need more than an update to “Select and initialise individual components” (Netlify preview), which this PR adds.
Only other thing I could think of may be to discuss “Initialising components” to the JavaScript API Reference to explain that initAll doesn’t throw but logs and individual initialisation throws, but there’s a bit of overlap with the JavaScript section of Import CSS, assets and JavaScript that lists all the options for initialising already. Seems like this would be a wider piece of work around structuring how we organise the JavaScript API docs (especially to keep the component names in the menu).
Part of the work for #341