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

GH Actions/basics: add check for valid XML docs + fix two docs #674

Merged
merged 2 commits into from
Nov 12, 2024

Conversation

jrfnl
Copy link
Member

@jrfnl jrfnl commented Nov 12, 2024

Description

Of course, found this issue when I'd already tagged the 3.11.0 release... oh well, guess I'll do another release later this week. At least with the new CI check, this won't be able to happen again.

GH Actions/basics: add check for valid XML docs

Verify basic well-formedness of the XML docs.

Docs: fix up two XML docs

  • The HereNowdocIdentifierSpacing one contained unescaped special chars in an attribute (oops).
  • The SpreadOperatorSpacingAfter line length did not conform (not found via the new CI check, but even so).

Suggested changelog entry

  • Generic.WhiteSpace.HereNowdocIdentifierSpacing: fixed broken XML documentation

Related issues/external references

Introduced in #586

Types of changes

  • Bug fix (non-breaking change which fixes an issue)

Sorry, something went wrong.

Verify basic well-formedness of the XML docs.

Verified

This commit was created on GitHub.com and signed with GitHub’s verified signature. The key has expired.
* The `HereNowdocIdentifierSpacing` one contained unescaped special chars in an attribute (oops).
* The `SpreadOperatorSpacingAfter` line length did not conform (not found via the new CI check, but even so).
@jrfnl jrfnl added this to the 3.11.1 milestone Nov 12, 2024
@jrfnl jrfnl merged commit 7f5d178 into master Nov 12, 2024
54 checks passed
@jrfnl jrfnl deleted the feature/validate-xml-doc-wellformedness branch November 12, 2024 15:20
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.

None yet

1 participant