feat: add phpdoc examples tag #636
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
bshaffer
commented
Jun 6, 2023
| * | ||
| * @return PhpDoc | ||
| */ | ||
| public static function sample(string $sampleFile): PhpDoc |
There was a problem hiding this comment.
note: I used the name sample for the function since the method name example is already taken
noahdietz
reviewed
Jun 6, 2023
| @@ -682,6 +684,9 @@ private function rpcMethod(MethodDetails $method): PhpClassMember | |||
| AST::method($method->methodName . 'Async'))(), | |||
| '.') | |||
| : null, | |||
| in_array($this->serviceDetails->migrationMode, [MigrationMode::MIGRATING, MigrationMode::NEW_SURFACE_ONLY]) | |||
There was a problem hiding this comment.
TIL: Way better way for checking migrationMode 😆
noahdietz
approved these changes
Jun 6, 2023
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
fixes #547
With phpDocumentor we could remove the prefixed
samples/by passing in--examplesdir=sampleswhen we runphpdoc. However, I think includingsamples/in the path is better, since it makes things less ambiguous for anyone looking at the code rather than the published docs.