Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

2024-Indentation - The Invisible Code Keeper #150

Open
wants to merge 4 commits into
base: master
Choose a base branch
from

Conversation

Likhithaaaa
Copy link
Collaborator

No description provided.

@Likhithaaaa Likhithaaaa added the 2024: round 2 articles of round 2 label Nov 25, 2024
@carinaschrenk
Copy link
Collaborator

Internal Feedback Round 2B-google-poll 28.11

Thoughts

  • The rethorical questions seem out of place
  • The text is clear and simple, explains it well (mentioned x2)
  • The graphic is nice (mentioned x2)
  • The cooking metaphor is overused, could a different metaphor be applied? (mentioned x2)
  • The word "convention" should be mentioned
  • Conflicting opinions on the metaphor:
    • two people said its not fitting/not necessary
    • someone else found it relatable

Ideas

  • Mentioning that proper indentation can also prevent syntax errors in some languages/are needed in some languages e.g., Python (mentioned x3)
  • Suggestion for an alternative story line:
    • show picture of monk scripts with beautiful "initials" (https://en.wikipedia.org/wiki/Initial),
    • then say that shifting the left margin (which provides the definition for indentation, which currently is missing) reveils a text's structure and the dependencies of text blocks.
    • Code is for humans, too, not only the machines.

Two general comments:

Just because something is listed here, does not mean you have to implement it.
You as the author still have the freedom to not make certain suggested changes.
This list is simply a collection of everything commented in the google poll.
I tried to structure the comments and merge similar ones and count how often this point was mentioned.
If a comment says "I think", this is not me (Carina), but someone who commented on the poll.

Second, a general comment on the 28.11 was, that the articles of 2024 are quite technical and complex in comparison to 2019.
We could all strive to make our articles more simple and understandable to the general public.
Not every technical term needs to be mentioned and explained.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants