Documentation on rules is missing details on how to configure them about rector HOT 3 CLOSED

The configure sample in markdown is removed because of buggy, ref rectorphp/rector-doctrine#238 (comment)

from rector.

Hi @joachim-n , thanks for feedback. We had a configuration examples before, but it lead to miss-understandings, especially in the complex ones. Markdown generator can go wrong very easily.

The code is the documentaiton here. That's why we went with configure() method convention. Every configurable rule has such a method, more complex accepting value objects. Those are designed to be explored in the IDE directly while writing rule configuration 👍

from rector.

Code is no substitute for documentation. For example, looking at ArgumentAdder:

    public function __construct(string $class, string $method, int $position, ?string $argumentName = null, $argumentDefaultValue = null, ?\PHPStan\Type\Type $argumentType = null, ?string $scope = null)
    {
        $this->class = $class;
        $this->method = $method;
        $this->position = $position;
        $this->argumentName = $argumentName;
        $this->argumentDefaultValue = $argumentDefaultValue;
        $this->argumentType = $argumentType;
        $this->scope = $scope;
        RectorAssert::className($class);
    }

What does $scope do? What are the possible values?
What do you pass in for $argumentType?
Is $position 0- or 1-indexed?
How do you specify that there is no default value (turns out you can't -- I wasted time on that).

from rector.