Skip to content

Ruby: use A/An/The to start qlDoc for classes#7170

Merged
erik-krogh merged 2 commits intogithub:mainfrom
erik-krogh:qldocStyle
Nov 19, 2021
Merged

Ruby: use A/An/The to start qlDoc for classes#7170
erik-krogh merged 2 commits intogithub:mainfrom
erik-krogh:qldocStyle

Conversation

@erik-krogh
Copy link
Copy Markdown
Contributor

QLDoc for classes should generally start with A/An/The.

I found a few violations of that during a dist-upgrade of codeql-ql.
Ruby was the worst offender, so I tried to fix them for you.

@erik-krogh erik-krogh added no-change-note-required This PR does not need a change note Ruby labels Nov 18, 2021
@erik-krogh erik-krogh marked this pull request as ready for review November 18, 2021 15:48
@erik-krogh erik-krogh requested a review from a team as a code owner November 18, 2021 15:48
Copy link
Copy Markdown
Contributor

@nickrolfe nickrolfe left a comment

Choose a reason for hiding this comment

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

Thanks! Just a few minor suggestions.

Comment thread ruby/ql/lib/codeql/ruby/frameworks/ActiveStorage.qll Outdated
Comment thread ruby/ql/lib/codeql/ruby/frameworks/StandardLibrary.qll Outdated
Comment thread ruby/ql/src/queries/security/cwe-078/KernelOpen.ql Outdated
Co-authored-by: Nick Rolfe <nickrolfe@github.com>
@erik-krogh erik-krogh merged commit 9f08aca into github:main Nov 19, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

no-change-note-required This PR does not need a change note Ruby

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants