- Sep 2022
-
metalblueberry.github.io metalblueberry.github.io
-
Some people eventually realize that the code quality is important, but they lack of the time to do it. This is the typical situation when you work under pressure or time constrains. It is hard to explain to you boss that you need another week to prepare your code when it is “already working”. So you ship the code anyway because you can not afford to spent one week more.
-
To see if you are writing good code, you can question yourself. how long it will take to fully transfer this project to another person? If the answer is uff, I don’t know… a few months… your code is like a magic scroll. most people can run it, but no body understand how it works. Strangely, I’ve seen several places where the IT department consist in dark wizards that craft scrolls to magically do things. The less people that understand your scroll, the more powerfully it is. Just like if life were a video game.
-
Code explains what and how Documentation explains why.
-
So make sure to write your documentation, but do not explain your spells.
-
This is so clear that you don’t even need comments to explain it.
-
Another type of comments are the ones trying to explain a spell.
-
Do not explain your spells, rewrite them.
Tags
- I agree
- documentation: good
- write code that humans can understand
- time constraints
- work: manager who understands what you do
- pressure
- hard to explain
- if you have to explain it, rewrite it to be simpler
- +0.8
- source code: comments: explain why, not what or how
- answer the "why?"
- +1.0
Annotators
URL
-
- May 2022
-
wordpress.com wordpress.com
-
"I didn't fully understand it at the time, but throughout my time as a freshman at Boston College I've realized that I have the power to alter myself for the better and broaden my perspective on life. For most of my high school experience, I was holding to antiquated thoughts that had an impact on the majority of my daily interactions. Throughout my life, growing up as a single child has affected the way am in social interactions. This was evident in high school class discussions, as I did not yet have the confidence to be talkative and participate even up until the spring term of my senior year."
Tags
- (Major Essay) Introduction paragraph
- Introduction p.1
- In this annotation, I choose to expand on my introduction. Before I explain why I chose the words I did, I should mention that my first draft failed to meet one of the assignment's primary requirements: a "Story like" structure. Finally, I decided to rework my introduction because my first draft did not begin with a clear beginning. Instead, I started by describing the fundamental context of the encounter before detailing my previous experiences. To improve my final edit, I made sure I described my experiences and/or how I felt before they occurred.
Annotators
URL
-
- Apr 2022
-
stackoverflow.com stackoverflow.com
-
Check both execution plans (using explain (analyze, verbose) and you'll see
-
- Feb 2022
- Aug 2021
-
github.com github.com
-
I hope you'll forgive me for defaulting to the documentation: I think it will do a better job of explaining it than me.
-
- Mar 2021
-
gitlab.gnome.org gitlab.gnome.org
-
I am wondering if it wasn't faster for maintainers/developers who know the glib code to just provide a fix instead of writing comments on this issue.
-
- Sep 2020
-
stackoverflow.com stackoverflow.com
-
do I really have to do something like that in order to have my local modules working? it's quite impracticable to explain it to a team! there's nothing a little bit more straightforward?
-
-
github.com github.com
-
Please focus on explaining the motivation so that if this RFC is not accepted, the motivation could be used to develop alternative solutions. In other words, enumerate the constraints you are trying to solve without coupling them too closely to the solution you have in mind.
Tags
- contribution guidelines: should explain motivation for change
- okay for proposal to not be accepted
- iterative process: building on previous attempts/work
- defining the problem clearly is as valuable coming up with specific implementation/solution
- answer the "why?"
- iterative process
Annotators
URL
-
- Nov 2019
-
github.com github.com
-
Description explains the issue / use-case resolved
-
- Oct 2017
-
arvrjourney.com arvrjourney.com
-
factors
-
vivo
-
- Feb 2016
-
learning.ccsso.org learning.ccsso.org
-
Explain major differences between poems, drama, and prose, and refer to the structural elements of poems (e.g., verse, rhythm, meter) and drama (e.g., casts of characters, settings, descriptions, dialogue, stage directions) when writing or speaking about a text.
For this standard, students would have to read a variety of poems, plays and prose to understand the structural differences. Then the students must use the structural knowledge to properly write and speak about poems and plays. A good play for this standard would be Annie and a good collections of poems to understand structure would be from poet Roald Dahl.
-
- Apr 2014
-
www.newschallenge.org www.newschallenge.org
-
science will produce improved results and better serve the community.
How will the results be improved and in what way will the community be better served?
I expect you explain how later in the document and provide examples, but to strengthen the intro and capture your readers give the a teaser of what's to come if they continue reading.
-