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

Style suggestions #12

Open
matthew-white opened this issue Apr 1, 2014 · 1 comment
Open

Style suggestions #12

matthew-white opened this issue Apr 1, 2014 · 1 comment
Labels

Comments

@matthew-white
Copy link

Do we want to include more style tips in our Stata trainings? — e.g., indent after an open brace. I find that many people start at IPA with an unprepossessing style, but not because they prefer it: they just haven't been exposed to alternatives or told why style is important. They could be introduced to style early on, even before 103...

Existing resources:
http://www.stata-journal.com/sjpdf.html?articlenum=pr0018
https://ipastorage.box.com/s/eth7131k23r66bsdoxs4

I think the dream would be a style guide like this one for C++ (though ours would be much shorter!):

http://geosoft.no/development/cppstyle.html#Naming%20Conventions

@hdiamondpollock
Copy link
Contributor

Interesting, my gut is that we should not include style too much within the body of the training (I feel it's likely to be glossed over) but certainly link to outside resources, which I think is already done. Though I agree introducing style a bit earlier is a good idea. Besides in 101, we never really show what a good do-file looks like, and in 101 it's probably too early to have people actually appreciate it. Perhaps in the future we have a problem set question where one has to identify the style errors in a do-file.

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

No branches or pull requests

2 participants