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

Replace [Bool] with [Boolean] in method comments according to the YARD convention. #10924

Merged
merged 1 commit into from Sep 7, 2021

Conversation

jolyot
Copy link
Contributor

@jolyot jolyot commented Sep 7, 2021

This PR is to replace [Bool] with [Boolean] in method comments.

In the project, @param [Boolean] or @return [Boolean] and @param [Bool] or @return [Bool] are mixed up in the method comments, so the goal is to unify them into @param [Boolean] or @return [Boolean] according to the YARD convention.

@dnkoutso
Copy link
Contributor

dnkoutso commented Sep 7, 2021

nice thanks! I wanted to do that at some point :) Can you also do one more PR for https://github.com/CocoaPods/Core?

@dnkoutso dnkoutso added this to the 1.12.0 milestone Sep 7, 2021
@dnkoutso
Copy link
Contributor

dnkoutso commented Sep 7, 2021

Looks like we need to fix CI.

Lint : .github#L1
The ubuntu-16.04 environment is deprecated and will be removed on September 20, 2021. Migrate to ubuntu-latest instead. For more details see https://github.com/actions/virtual-environments/issues/3287

I will do that in another PR now.

@dnkoutso
Copy link
Contributor

dnkoutso commented Sep 7, 2021

CI fix here #10925 @jolyot you will have to rebase shortly once it lands.

@dnkoutso
Copy link
Contributor

dnkoutso commented Sep 7, 2021

@jolyot all merged to master. Please rebase this PR so CI can start and we can land this! Thank you!

@jolyot
Copy link
Contributor Author

jolyot commented Sep 7, 2021

@dnkoutso
I rebased this PR. And I opened a related PR for https://github.com/CocoaPods/Core.

@dnkoutso
Copy link
Contributor

dnkoutso commented Sep 7, 2021

Merged core, will merge this one once its green.

@CocoaPodsBarista
Copy link

1 Warning
⚠️ Please include a CHANGELOG entry to credit yourself!
You can find it at CHANGELOG.md.

Here's an example of your CHANGELOG entry:

* Replace [Bool] with [Boolean] in method comments  according to the YARD convention.  
  [jolyot](https://github.com/jolyot)
  [#issue_number](https://github.com/CocoaPods/CocoaPods/issues/issue_number)

note: There are two invisible spaces after the entry's text.

Generated by 🚫 Danger

@dnkoutso dnkoutso merged commit e83d326 into CocoaPods:master Sep 7, 2021
@jolyot jolyot deleted the replace-bool-with-boolean branch September 7, 2021 17:02
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.

None yet

3 participants