Documentation - Typos & Consistency Fixes #1841

joey-gm · 2023-06-25T12:09:56Z

Fixes some typos and formatting inconsistencies.

kimdv

Hi @joey-gm and welcome to SwiftSyntax! 🥳

Thanks for going trough the documentation and typos.
I see that you have changed some files in the generated files.
Those files are generated automatically by the Codegenerator.

Those files should be changed in the corresponding template file.
After that you navigate inside CodeGeneration folder and run swift run generate-swiftsyntax ../Sources

This will ensure that the generated code at update correctly.
If there is any question feel free to comment on this PR and I will gladly help you.

joey-gm · 2023-06-26T10:34:02Z

Sources/SwiftSyntax/generated/syntaxNodes/SyntaxStmtNodes.swift

@@ -1575,8 +1575,7 @@ public struct MissingStmtSyntax: StmtSyntaxProtocol, SyntaxHashable {
    }
  }

-  /// A placeholder, i.e. `<#statement#>` that can be inserted into the source code to represent the missing pattern.
-  /// This token should always have `presence = .missing`.
+  /// A placeholder, i.e. `<#statement#>` that can be inserted into the source code to represent the missing pattern./// This token should always have `presence = .missing`.


Seems like CodeGeneration fails to add a proper line break for this particular comment.

I tried various line break options (e.g. extra spaces) in the codegen file below without avail.

https://github.com/apple/swift-syntax/blob/5922b69d0db36e5ebdadfe7a893f00ca576cb2e6/CodeGeneration/Sources/SyntaxSupport/CommonNodes.swift#L234

joey-gm · 2023-06-26T10:36:12Z

@kimdv Thanks for the guidance and instruction!

I have fixed the typos in the corresponding template files under CodeGeneration, and have re-generated the swift codes. All files should now be in sync.

ahoppen

Thank you for fixing all those typos @joey-gm. I’ve got a couple of comments inline, otherwise it looks good to me.

CodeGeneration/Sources/generate-swiftsyntax/templates/swiftsyntax/SyntaxVisitorFile.swift

Sources/SwiftParser/SwiftParserCompatibility.swift

Sources/SwiftParser/TokenPrecedence.swift

Sources/SwiftSyntax/SwiftSyntaxCompatibility.swift

Sources/SwiftSyntaxBuilder/SwiftSyntaxBuilderCompatibility.swift

joey-gm · 2023-06-26T12:30:03Z

Thank you for fixing all those typos @joey-gm. I’ve got a couple of comments inline, otherwise it looks good to me.

Thanks! Incorporated your suggestions.

ahoppen

Thanks. Two more comments.

Could you also squash your commits? It just makes for a nicer git history.

Sources/SwiftParser/TokenPrecedence.swift

CodeGeneration/Sources/generate-swiftsyntax/templates/swiftsyntax/SyntaxVisitorFile.swift

ahoppen · 2023-06-26T13:07:18Z

Sources/SwiftSyntax/generated/SyntaxVisitor.swift

-/// The enum describes how the SyntaxVistor should continue after visiting
+/// The enum describes how the SyntaxVisitor should continue after visiting


I don’t think you re-generated SyntaxVisitor. If you did, this line would be

/// The enum describes how the ``SyntaxVisitor`` should continue after visiting

ahoppen

One more squash of these two commits and we’re ready to merge.

joey-gm · 2023-06-26T13:15:58Z

One more squash of these two commits and we’re ready to merge.

All done. Thanks!

ahoppen

Thanks. Once CI passes, I’ll merge the PR

ahoppen · 2023-06-26T21:03:23Z

@swift-ci Please test

ahoppen · 2023-06-27T07:14:21Z

@joey-gm Unfortunately we’ve got a merge conflict now. Could you rebase your changes on top of main?

The CI failures are because we need to update a test case in the apple/swift repo, which I’m doing in swiftlang/swift#66950.

ahoppen · 2023-06-27T08:24:55Z

@swift-ci Please test

joey-gm · 2023-06-27T08:25:31Z

Hi Alex @ahoppen,

I've rebased and recommitted the changes.

Below are the steps I’ve taken. Could you please review and make sure I’ve rebased properly? (I’m an amateur and not too familiar with git’s branch management. I skimmed through the changes in the latest commit and they look okay.)

Thanks!

(Sync my main branch with the Apple's main)
git checkout documentation // documentation is the branch which I made the changes locally
git rebase main

(Regenerate codes)
cd CodeGeneration
swift run generate-swiftsyntax ../Sources

(Soft reset, commit, and push)
cd ..
git reset --soft main
git commit -m "Documentation - Typos & Consistency Fixes"
git push -f

kimdv · 2023-06-27T08:28:44Z

@swift-ci please test windows

ahoppen · 2023-06-27T11:16:42Z

You’re rebase looks good, @joey-gm.

ahoppen · 2023-06-27T11:16:45Z

swiftlang/swift#66950

@swift-ci Please test

ahoppen · 2023-06-27T12:41:39Z

CI is currently failing with an unrelated issue (#1855). I’ll trigger CI agains once that issue has been resolved.

kimdv · 2023-06-27T18:02:11Z

swiftlang/swift#66950

@swift-ci Please test

kimdv · 2023-06-28T04:14:13Z

swiftlang/swift#66950

@swift-ci Please test

ahoppen · 2023-06-28T08:01:09Z

A few tests in this repo failed, AFAICT mostly because of the “preceed” -> “precede” rename. Could you adjust those failing test cases?

joey-gm · 2023-06-28T08:32:56Z

A few tests in this repo failed, AFAICT mostly because of the “preceed” -> “precede” rename. Could you adjust those failing test cases?

Fixed the typos and also changed the "eofToken" terminology to "endOfFileToken" in Tests/SwiftSyntaxTest/DebugDescriptionTests.swift

Passed all the tests in my local branch (macOS)

kimdv · 2023-06-28T08:34:42Z

A few tests in this repo failed, AFAICT mostly because of the “preceed” -> “precede” rename. Could you adjust those failing test cases?

Fixed the typos and also changed the "eofToken" terminology to "endOfFileToken" in Tests/SwiftSyntaxTest/DebugDescriptionTests.swift

Passed all the tests in my local branch (macOS)

Have a PR open for fixing the endOfFileToken in #1860

kimdv · 2023-06-29T04:54:45Z

@joey-gm if you rebase this branch it should be fixed

kimdv · 2023-06-29T05:25:21Z

@swift-ci please test

ahoppen

Thank you 🙏🏽

ahoppen · 2023-07-06T08:22:43Z

@swift-ci Please test

ahoppen · 2023-07-06T11:28:55Z

swiftlang/swift#66950

@swift-ci Please test macOS

ahoppen · 2023-07-07T10:17:08Z

I’m sorry @joey-gm, this PR conflicted with #1878. Could you rebase once more.

joey-gm · 2023-07-07T12:39:09Z

I’m sorry @joey-gm, this PR conflicted with #1878. Could you rebase once more.

@ahoppen Updated and rebased. Please kindly check and test if this resolves the conflict.

ahoppen · 2023-07-07T12:48:20Z

Thank you! Let’s trigger CI again.

ahoppen · 2023-07-07T12:48:23Z

@swift-ci Please test

ahoppen · 2023-07-07T12:48:38Z

@swift-ci Please test Windows

ahoppen

CI found one more inconsistency where you only updated a generated file. I hope that we can get this merged soon.

ahoppen · 2023-07-07T13:52:15Z

Sources/SwiftSyntax/generated/syntaxNodes/SyntaxDeclNodes.swift

-  /// The arguments of the initializer. While the function signature allows specifying an return clause, doing so is not semantically valid.
+  /// The arguments of the initializer. While the function signature allows specifying a return clause, doing so is not semantically valid.


This file is being generated. You need to also fix the typo here:

https://github.com/apple/swift-syntax/blob/1d36fc2b6a923a1ae79eede12bdd977632e33815/CodeGeneration/Sources/SyntaxSupport/DeclNodes.swift#L1344

joey-gm · 2023-07-07T14:37:54Z

CodeGeneration/Sources/SyntaxSupport/DeclNodes.swift

@@ -1353,7 +1353,7 @@ public let DECL_NODES: [Node] = [
      Child(
        name: "Body",
        kind: .node(kind: .codeBlock),
-        documentation: "The initializer’s body. Missing if the initialier is a requirement of a protocol declaration.",
+        documentation: "The initializer’s body. Missing if the initializer is a requirement of a protocol declaration.",


Fixed one more typo and regenerated the codes

joey-gm · 2023-07-07T14:38:55Z

CI found one more inconsistency where you only updated a generated file. I hope that we can get this merged soon.

Updated. Please kindly test. :)

ahoppen · 2023-07-07T17:26:29Z

@swift-ci Please test

ahoppen · 2023-07-07T20:58:31Z

swiftlang/swift#66950

@swift-ci Please test

joey-gm requested review from DougGregor and ahoppen as code owners June 25, 2023 12:09

kimdv requested changes Jun 26, 2023

View reviewed changes

joey-gm commented Jun 26, 2023

View reviewed changes

ahoppen reviewed Jun 26, 2023

View reviewed changes

Sources/SwiftParser/TokenPrecedence.swift Outdated Show resolved Hide resolved

Sources/SwiftParser/TokenPrecedence.swift Outdated Show resolved Hide resolved

CodeGeneration/Sources/generate-swiftsyntax/templates/swiftsyntax/SyntaxVisitorFile.swift Outdated Show resolved Hide resolved

ahoppen reviewed Jun 26, 2023

View reviewed changes

ahoppen approved these changes Jun 26, 2023

View reviewed changes

ahoppen enabled auto-merge June 26, 2023 14:55

ahoppen mentioned this pull request Jun 27, 2023

[Parse] Fix a typo in the new parser diagnostics swiftlang/swift#66950

Merged

auto-merge was automatically disabled June 27, 2023 08:16
Head branch was pushed to by a user without write access

ahoppen enabled auto-merge June 27, 2023 08:24

ahoppen disabled auto-merge June 27, 2023 11:17

ahoppen approved these changes Jul 6, 2023

View reviewed changes

ahoppen enabled auto-merge July 7, 2023 12:48

ahoppen reviewed Jul 7, 2023

View reviewed changes

auto-merge was automatically disabled July 7, 2023 14:26
Head branch was pushed to by a user without write access

Documentation - Typos & Consistency Fixes

f8ed0c4

joey-gm commented Jul 7, 2023

View reviewed changes

ahoppen enabled auto-merge July 7, 2023 17:26

ahoppen disabled auto-merge July 7, 2023 20:58

ahoppen merged commit c808498 into swiftlang:main Jul 8, 2023

		/// The enum describes how the SyntaxVistor should continue after visiting
		/// The enum describes how the SyntaxVisitor should continue after visiting

		/// The arguments of the initializer. While the function signature allows specifying an return clause, doing so is not semantically valid.
		/// The arguments of the initializer. While the function signature allows specifying a return clause, doing so is not semantically valid.

Documentation - Typos & Consistency Fixes #1841

Documentation - Typos & Consistency Fixes #1841

Uh oh!

Conversation

joey-gm commented Jun 25, 2023

Uh oh!

kimdv left a comment • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

joey-gm Jun 26, 2023

Choose a reason for hiding this comment

Uh oh!

joey-gm commented Jun 26, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

ahoppen left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

joey-gm commented Jun 26, 2023

Uh oh!

ahoppen left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

ahoppen Jun 26, 2023

Choose a reason for hiding this comment

Uh oh!

ahoppen left a comment

Choose a reason for hiding this comment

Uh oh!

joey-gm commented Jun 26, 2023

Uh oh!

ahoppen left a comment

Choose a reason for hiding this comment

Uh oh!

ahoppen commented Jun 26, 2023

Uh oh!

ahoppen commented Jun 27, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

ahoppen commented Jun 27, 2023

Uh oh!

joey-gm commented Jun 27, 2023

Uh oh!

kimdv commented Jun 27, 2023

Uh oh!

ahoppen commented Jun 27, 2023

Uh oh!

ahoppen commented Jun 27, 2023

Uh oh!

ahoppen commented Jun 27, 2023

Uh oh!

kimdv commented Jun 27, 2023

Uh oh!

kimdv commented Jun 28, 2023

Uh oh!

ahoppen commented Jun 28, 2023

Uh oh!

joey-gm commented Jun 28, 2023

Uh oh!

kimdv commented Jun 28, 2023

Uh oh!

kimdv commented Jun 29, 2023

Uh oh!

kimdv commented Jun 29, 2023

Uh oh!

ahoppen left a comment

Choose a reason for hiding this comment

Uh oh!

ahoppen commented Jul 6, 2023

Uh oh!

ahoppen commented Jul 6, 2023

kimdv left a comment •

edited

Loading

joey-gm commented Jun 26, 2023 •

edited

Loading

ahoppen commented Jun 27, 2023 •

edited

Loading