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

reference doc: fix incorrect syntax production #19017

Merged
merged 1 commit into from
Nov 22, 2023

Conversation

SethTisue
Copy link
Member

as reported by @bjornregnell on Discord

this brings the doc page in line with https://github.com/lampepfl/dotty/blob/main/docs/_docs/internals/syntax.md

@SethTisue SethTisue requested a review from som-snytt November 21, 2023 21:26
@bjornregnell
Copy link
Contributor

related to #19016

@som-snytt
Copy link
Contributor

This is one of those weird dotty does it this way things?

➜  dotty git:(issue/11723-doc-param-order) grep StructuralIn $(find docs -type f)
docs/_docs/internals/syntax.md:GivenDef          ::=  [GivenSig] (AnnotType [‘=’ Expr] | StructuralInstance)
docs/_docs/internals/syntax.md:StructuralInstance ::=  ConstrApp {‘with’ ConstrApp} [‘with’ WithTemplateBody]
docs/_docs/reference/contextual/givens.md:GivenDef            ::=  [GivenSig] StructuralInstance
docs/_docs/reference/contextual/givens.md:StructuralInstance  ::=  ConstrApp {‘with’ ConstrApp} ‘with’ TemplateBody
docs/_docs/reference/syntax.md:GivenDef          ::=  [GivenSig] (AnnotType [‘=’ Expr] | StructuralInstance)
docs/_docs/reference/syntax.md:StructuralInstance ::=  ConstrApp {‘with’ ConstrApp} [‘with’ WithTemplateBody]
docs/_spec/TODOreference/contextual/givens.md:GivenDef            ::=  [GivenSig] StructuralInstance
docs/_spec/TODOreference/contextual/givens.md:StructuralInstance  ::=  ConstrApp {‘with’ ConstrApp} ‘with’ TemplateBody
docs/_spec/13-syntax-summary.md:GivenDef          ::=  [GivenSig] (AnnotType [‘=’ Expr] | StructuralInstance)
docs/_spec/13-syntax-summary.md:StructuralInstance ::=  ConstrApp {‘with’ ConstrApp} [‘with’ WithTemplateBody]

Do I see one missing bracket under the TODO. Why am I scanning multiple bits of text by eye?

This is what computers are for. I mean computers before AI.

After AI, grep is like, maybe this one?

Copy link
Contributor

@som-snytt som-snytt left a comment

Choose a reason for hiding this comment

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

Maybe missed one?

My favorite ad is the guy gets off the elevator (lift) and dances to call me maybe. He is chewing gum, so I guess the import of the ad is all the things you can do while chewing gum. It's quite amazing, and I will try it.

Copy link
Contributor

@odersky odersky left a comment

Choose a reason for hiding this comment

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

Thanks for the fix!

@SethTisue
Copy link
Member Author

SethTisue commented Nov 22, 2023

Maybe missed one?

@som-snytt ah, thanks for calling this to our attention

@sjrd the TODOreference directory was added by Quentin in 34b836b when he was working on the spec. You're the specmeister these days; would a separate PR removing that directory in its entirety be accepted? (I'm hoping for a "yes", of course. If the files are useful, perhaps they could live on a branch?)

Regardless, merging this PR in its current form.

@SethTisue SethTisue dismissed som-snytt’s stale review November 22, 2023 03:59

the TODOreference directory is a maintenance burden; can we remove it?

@SethTisue SethTisue merged commit 6b69c39 into scala:main Nov 22, 2023
18 checks passed
@SethTisue SethTisue deleted the fix-structural-instance-production branch November 22, 2023 03:59
@Kordyjan Kordyjan added this to the 3.4.0 milestone Dec 20, 2023
WojciechMazur added a commit that referenced this pull request Jun 23, 2024
)

Backports #19017 to the LTS branch.

PR submitted by the release tooling.
[skip ci]
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants