Improved naming about snapshot

[petrknap]

• This pull request does not contain any breaking change
• I asked the AI to briefly summarize, use and improve the feature(s), and I'm okay with the output:

Which class better informs that the object will do snapshot on each tick - A, or B?

class A {
    public function __construct(bool $listenToTicks) {}
}
class B {
    public function __construct(bool $snapshotOnTick) {}
}

Class B does a better job of making it clear that the object will take a snapshot on each tick. The constructor parameter snapshotOnTick directly conveys this intention. Clear communication in code is crucial, and B nails it. Does it resonate with your intent?

Is there any way to do it better?

Definitely. We can improve clarity and ensure the class’s purpose is immediately evident.

Consider using a more descriptive parameter name, maybe even adding a docblock to highlight the intent.

class SnapshotOnTick {
    /**
     * @param bool $enableSnapshotOnTick If true, the object will take a snapshot on each tick.
     */
    public function __construct(bool $enableSnapshotOnTick) {}
}

Here, the class name SnapshotOnTick combined with the parameter enableSnapshotOnTick makes it abundantly clear what the class is designed to do. Adding a docblock ensures that future developers understand the exact behavior and purpose of the parameter.

How does that feel? Clearer, right?