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.

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

"Both opening and closing quote characters must be on their own line." #41767

Closed
phillijw opened this issue Jul 15, 2024 · 3 comments · Fixed by #41812
Closed

"Both opening and closing quote characters must be on their own line." #41767

phillijw opened this issue Jul 15, 2024 · 3 comments · Fixed by #41812
Labels
doc-enhancement Improve the current content [org][type][category] dotnet-csharp/svc help wanted Good for community contributors to help [up-for-grabs] lang-reference/subsvc Pri1 High priority, do before Pri2 and Pri3

Comments

@phillijw
Copy link

Type of issue

Other (describe below)

Description

Misleading text. I would rephrase it as:

"Both opening and closing quote characters must be on separate lines."

At least I think that's how it's supposed to work.

Page URL

https://learn.microsoft.com/en-us/dotnet/csharp/language-reference/tokens/raw-string

Content source URL

https://github.com/dotnet/docs/blob/main/docs/csharp/language-reference/tokens/raw-string.md

Document Version Independent Id

5737c986-9b06-9444-f7bc-893607d390d7

Article author

@BillWagner

Metadata

  • ID: 62bd57d5-0e7d-4355-0689-4b6b90ab4057
  • Service: dotnet-csharp
  • Sub-service: lang-reference
@dotnet-bot dotnet-bot added the ⌚ Not Triaged Not triaged label Jul 15, 2024
@issues-automation issues-automation bot added dotnet-csharp/svc lang-reference/subsvc Pri1 High priority, do before Pri2 and Pri3 labels Jul 15, 2024
@BillWagner
Copy link
Member

Hi @phillijw

There's probably room for improvement here. I'd like to suggest alternatives to your proposal because I think that could be misinterpreted as well. Reading your text, I would expect the following to be legal (it's not):

var rawString = """This is a
    multiline raw string literal. """;

The """ token is on "separate lines".

Maybe something like:

"In a multiline raw string literal, the opening quotes must be the last non-comment token on that line, and the closing quote must be first non-comment token on that line".

That's a bit pedantic, but it's more accurate.

@BillWagner BillWagner added the discussion Indicates issues that are being discussed label Jul 16, 2024
@phillijw
Copy link
Author

I wasn't actually 100% sure how it was supposed to work (which is why I was reading the docs in the first place) but I think your adjustment makes sense.

@BillWagner BillWagner added help wanted Good for community contributors to help [up-for-grabs] and removed discussion Indicates issues that are being discussed labels Jul 17, 2024
@BillWagner
Copy link
Member

Putting in the backlog, to use the suggested text in my previous comment.

I also added the "help wanted" tag, if anyone wants to submit a PR before we make the next updates.

@BillWagner BillWagner added the doc-enhancement Improve the current content [org][type][category] label Jul 17, 2024
@dotnet-bot dotnet-bot removed the ⌚ Not Triaged Not triaged label Jul 17, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
doc-enhancement Improve the current content [org][type][category] dotnet-csharp/svc help wanted Good for community contributors to help [up-for-grabs] lang-reference/subsvc Pri1 High priority, do before Pri2 and Pri3
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants