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

Simplify the Git intro by minimizing new concepts directly not relevent for git #4

Closed
Sabryr opened this issue Feb 10, 2017 · 3 comments

Comments

@Sabryr
Copy link
Member

Sabryr commented Feb 10, 2017

  1. Change the python example to a simple text file or a shell script (e.g just echo "sabryr added this line" ) and compare with the comments. Then emphasize the importance of the comments when the changes are not trivial.
    Reason:
    A. This is a git intro and remove the mentioning of Python
    B. Diff is easier to comprehend when it is just text, or simple script

*This is a suggestion and if someone has a good counter argument I will take it as it is.

@Jyrsa
Copy link
Contributor

Jyrsa commented Feb 10, 2017

I'd suggest print statements in Python. probably simpler than a shell script.

@bast
Copy link
Member

bast commented Feb 10, 2017

I agree that Python is possibly better (more familiar) than shell script. However we can simplify the Python code. I would remove all the __name__ stuff. If you have never coded Python, then this is just confusing. I also like examples with text files but I personally find examples with "radovan added this line" boring. I would go for a recipe or a poem or a song text.

@bast
Copy link
Member

bast commented Feb 18, 2017

We need to replace/simplify this example:

# i am a comment
from hello import say_hello
if __name__ == "__main__":
    say_hello()

@bast bast closed this as completed in 0d2c272 Feb 20, 2017
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

3 participants