search

consolidation / robo

Modern task runner for PHP
http://robo.li
Other
2.67k stars 304 forks source link

Document method parameters and return types #1122

Closed Naktibalda closed 2 years ago

Naktibalda commented 2 years ago

Overview

This pull request:

Summary

A lot of redundant @param and @return annotation had been removed after declaring correct types in Codeception.

This change documents declared types of method parameters and return types.

Description

Effect of this change can be seen at https://github.com/Codeception/codeception.github.com/pull/646

DavertMik commented 2 years ago

This PR changes only GenMarkdownTask which we use internally in Codeception so I'm for this to be merged @greg-1-anderson are you ok with that?

DavertMik commented 2 years ago

@greg-1-anderson can we merge it?

DavertMik commented 2 years ago

@greg-1-anderson I'm merging it?

Naktibalda commented 2 years ago

I made a small change to document parameters in correct order, when some parameters have @param annotations and others don't.

Effect can be seen in this commit: https://github.com/Codeception/codeception.github.com/commit/36b6d9891080afab38dcb14284b988c9614a3793

greg-1-anderson commented 2 years ago

LGTM. Thanks.