sirlilpanda/c_state_pattern
1
0
Fork 0
Code Issues 4 Pull Requests 1 Actions Packages Projects Releases Wiki Activity

Wording suggestions #5

New Issue
Open
opened 2025-09-03 00:56:37 -07:00 by jordan · 0 comments
jordan commented 2025-09-03 00:56:37 -07:00
Copy Link

I have collated my thoughts on rewording your README/tutorial to improve flow. Feel free to pick and choose what you think fits. For brevity's sake, I've assumed that you've already dealt with issue #3.

  • README.md, line 5: the state pattern is a pattern that aims to get rid of the mess that a state machine causes within your code. So i propose a problem for you... -> The state pattern aims to improve the maintainability of state machines. As an example I pose the following problem...
  • README.md, lines 7 to 53: suggest this is reworded so that there is a clear mapping between impetus and response (i.e. buttons and what they do, akin to a formal specification). Perhaps use a mermaid diagram instead of the ASCII art too for consistency and clarity.

I am going to leave this as is for now as I've started to focus on the conceptual content (e.g. #4), but I would like to add to this as the article is iterated on.

I have collated my thoughts on rewording your README/tutorial to improve flow. Feel free to pick and choose what you think fits. For brevity's sake, I've assumed that you've already dealt with issue #3. - [ ] README.md, line 5: ~~the state pattern is a pattern that aims to get rid of the mess that a state machine causes within your code. So i propose a problem for you...~~ -> The state pattern aims to improve the maintainability of state machines. As an example I pose the following problem... - [ ] README.md, lines 7 to 53: suggest this is reworded so that there is a clear mapping between impetus and response (i.e. buttons and what they do, akin to a formal specification). Perhaps use a mermaid diagram instead of the ASCII art too for consistency and clarity. I am going to leave this as is for now as I've started to focus on the conceptual content (e.g. #4), but I would like to add to this as the article is iterated on.
sirlilpanda added a new dependency 2025-09-06 15:25:45 -07:00
#3 Capitalisation is all over the place.
sirlilpanda added reference making-readme-more-tutorial-like 2025-09-06 20:46:35 -07:00
Sign in to join this conversation.
making-readme-more-tutorial-like
Branches Tags
Labels
No items
No Label
Milestone
No items
No Milestone
Projects
Clear projects
No project
Assignees
Clear assignees
sirlilpanda
No Assignees
1 Participants
Notifications
Due Date
No due date set.
Depends on
#3 Capitalisation is all over the place.
sirlilpanda/c_state_pattern
Reference: sirlilpanda/c_state_pattern#5
No description provided.
Delete Branch "%!s()"

Deleting a branch is permanent. Although the deleted branch may continue to exist for a short time before it actually gets removed, it CANNOT be undone in most cases. Continue?