Bloc: Documentation: Naming conventions and Tutorial discrepency

[suragch]

I'm going through the tutorials. I came to the Timer tutorial. In there we are told to name the events Start, Pause, Resume, Reset, and Tick.

However, according to the naming conventions, I would expect the names to be TimerStarted, TimerPaused, TimerResumed, TimerReset, and TimerTicked.

The state names in the Timer tutorial seem fine to me, but they also don't conform to the naming conventions.

I haven't gone through all the tutorials yet so I don't know if other tutorials follow the naming conventions or not.

I'm sure everyone can choose for themselves whether or not to follow the naming conventions, but it seems like it would make the documentation better if it were self-consistent.

[fotiDim]

I noticed the same inconsistency with State names. In the documentation it states

State should be one of the following: Initial | Success | Failure | InProgress and initial states should follow the convention: BlocSubject + Initial.

• In the weather example there is a state named WeatherLoaded while that should be an event name.
• Loading instead of InProgress is used.

It would be nice to update the examples using the recommended naming scheme as this confuses newcomers to the library.

[felangel]

Hi @fotiDim 👋
Thanks for opening an issue!

I’m in the process of updating the names in the tutorials to align. The naming should be correct in the actual example code though. Should have it done this weekend at the latest 👍

[yvonmanzi]

@felangel Just worked through most of BLoC examples using the recommended naming convention. Let me know if you need me to help out with updating the naming.

[felangel]

I believe all of the documentation and examples should adhere to the naming conventions. Please feel free to comment if you find anything I missed 👍

[suragch]

Thank you, Felix! That will make it more clear for a lot of people.

[fotiDim]

That is great! When can we except the website to update?

EDIT: I see it now! I will go through them on Monday.