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

[NFC] Fix a bunch of docstrings #11034

Merged
merged 2 commits into from
Nov 15, 2017
Merged

[NFC] Fix a bunch of docstrings #11034

merged 2 commits into from
Nov 15, 2017

Conversation

ejegg
Copy link
Contributor

@ejegg ejegg commented Sep 28, 2017

Overview

Fix parameter and return types in docstrings

Before

The current status. Please provide screenshots or gifs (LICEcap, SilentCast) where appropriate.

After

What has been changed. Please provide screenshots or gifs (LICEcap, SilentCast) where appropriate.

Technical Details

If the PR introduces noteworthy technical changes, please describe them here. Provide code snippets if necessary

Comments

Anything else you would like the reviewer to note

@seamuslee001
Copy link
Contributor

Jenkins re test this please

@@ -1110,6 +1110,7 @@ public static function usesPriceSet($id) {
* @param int $participantId
* @param bool $isTest
* @param bool $returnMessageText
* @return array
Copy link
Member

Choose a reason for hiding this comment

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

I think this should be array|null ? (it only returns an array depending on the returnMessageText parameter)

@mlutfy mlutfy changed the title Fix a bunch of docstrings [NFC] Fix a bunch of docstrings Nov 15, 2017
@mlutfy
Copy link
Member

mlutfy commented Nov 15, 2017

@ejegg Can you double-check that line? Seems OK to merge afterwards. Thanks!

@mlutfy mlutfy merged commit 23e935e into civicrm:master Nov 15, 2017
@ejegg ejegg deleted the docStrings branch November 30, 2017 16:38
sluc23 pushed a commit to ixiam/civicrm-core that referenced this pull request Jan 10, 2018
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants