Skip to content
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.

Sign up for GitHub

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

Jump to bottom

docs: rework docs around errors #11802

Merged
merged 5 commits into from
Sep 2, 2024
Merged

docs: rework docs around errors #11802

merged 5 commits into from
Sep 2, 2024

Conversation

Princesseuh
Copy link
Member

@Princesseuh Princesseuh commented Aug 21, 2024 •
edited
Loading

Changes

Require withastro/docs#9157

People keep removing errors, we cannot change people, but we can make it acceptable to remove errors if that's what more intuitive.

I also took this opportunity to refine some parts of the document

Testing

N/A

Docs

It's all docs

@changeset-bot changeset-bot
Copy link

changeset-bot bot commented Aug 21, 2024 •
edited
Loading

⚠️ No Changeset found

Latest commit: b4791e8

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

@github-actions github-actions bot added pkg: astro Related to the core `astro` package (scope) pr: docs A PR that includes documentation for review labels Aug 21, 2024
delucis
delucis reviewed Aug 21, 2024
View reviewed changes
packages/astro/src/core/errors/README.md Outdated Show resolved Hide resolved
packages/astro/src/core/errors/README.md
- Contextual information may be used to enhance the message or the hint. However, the code that caused the error or the position of the error should not be included in the message as they will already be shown as part of the error.
- Do not prefix `title`, `message` and `hint` with descriptive words such as "Error:" or "Hint:" as it may lead to duplicated labels in the UI / CLI.
- Dynamic error messages must use the following shape:
- Dynamic error messages **must** use the following shape:
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

😄

Copy link
Member Author

@Princesseuh Princesseuh Aug 21, 2024 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

next step will be in all caps (or writing an ESLint plugin)

@ematipico
Copy link
Member

How would docs rework this part?

@Princesseuh
Copy link
Member Author

How would docs rework this part?

I'm not sure I understand what you mean?

@ematipico
Copy link
Member

When we remove an error that was previously published, are we going to send the users to an URL that is 404?

@Princesseuh
Copy link
Member Author

When we remove an error that was previously published, are we going to send the users to an URL that is 404?

No, see the linked docs PR

@ematipico
Copy link
Member

Thank you!

@Princesseuh Princesseuh merged commit 39d330f into main Sep 2, 2024
4 checks passed
@Princesseuh Princesseuh deleted the docs/errors branch September 2, 2024 09:43
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@bluwy bluwy bluwy approved these changes

@ematipico ematipico ematipico approved these changes

@delucis delucis delucis approved these changes

Assignees
No one assigned
Labels
docs pr pkg: astro Related to the core `astro` package (scope) pr: docs A PR that includes documentation for review
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
4 participants
@Princesseuh @ematipico @delucis @bluwy