Skip to content

docs: convert ErrorHandling from .rst to .md #62297

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.

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

Merged
merged 2 commits into from
Nov 30, 2022
Merged

Conversation

MaxDesiatov
Copy link
Contributor

Resolves partially #49997.

@MaxDesiatov
Copy link
Contributor Author

@swift-ci please smoke test

1 similar comment
@MaxDesiatov
Copy link
Contributor Author

@swift-ci please smoke test

Copy link
Collaborator

@AnthonyLatsis AnthonyLatsis left a comment

Choose a reason for hiding this comment

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

Thanks! Why are all the apostrophes and quotes escaped?

@AnthonyLatsis
Copy link
Collaborator

I suspect the diff is all red because some functions in the snippets don’t have a closing brace.

@MaxDesiatov
Copy link
Contributor Author

Thanks! Why are all the apostrophes and quotes escaped?

That's the behaviour of the tool that I use for conversion. Unfortunately, I'm not sure if it's customizable, and I'd prefer to stay on the safe side in case something actually has to be escaped. Backslashes before apostrophes and quotes have no effect on how those are rendered, so it seems safe to keep them.

@AnthonyLatsis
Copy link
Collaborator

AnthonyLatsis commented Nov 29, 2022

I see. I tend to be pedantic about this sort of benign though unnecessary noise, but I will leave this to the other reviewers’ discretion ✌🏻

Error handling is a well-trod path, with many different approaches in
other languages, many of them problematic in various ways. We believe
that our approach provides an elegant solution, drawing on the lessons
we\'ve learned from other languages and fixing or avoiding some of the
Copy link
Contributor

Choose a reason for hiding this comment

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

Do we need to escape 's?


## Kinds of Error

What exactly is an \"error\"? There are many possible error conditions,
Copy link
Contributor

Choose a reason for hiding this comment

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

Same with "?

@MaxDesiatov MaxDesiatov force-pushed the maxd/docs-error-handling branch from ecc0039 to beb846f Compare November 30, 2022 15:43
@MaxDesiatov MaxDesiatov force-pushed the maxd/docs-error-handling branch from beb846f to 4296351 Compare November 30, 2022 15:47
@MaxDesiatov
Copy link
Contributor Author

@swift-ci please smoke test and merge

@swift-ci swift-ci merged commit 51c5da0 into main Nov 30, 2022
@swift-ci swift-ci deleted the maxd/docs-error-handling branch November 30, 2022 18:24
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants