mythryl/mythryl — Issue #2: Best Practices
Author: spiralofhope
Created: 2012-01-06 01:17:57+00:00
State: open

http://mythryl.org/pipermail/mythryl/2011-August/000420.html

> ... I concluded that the best palliative for the problem in question
> is to habitually put the body of each script in curly braces, with outside
> of them only any statements which actually NEED to modify the global
> environment of the script:

```
#!/usr/bin/mythryl

global_environment_changing_statement ();

{
main_body_of_script ();
};
```

> At some point I need to make a pass over the online tutorials updating
> them to reflect this revised notion of "best practices".

---

My recommendation is to update the documentation as follows:

- Edit http://mythryl.org/
- In the section `Language Reference`, add a new "Best Practices" or perhaps "Recommended Practices" link at the bottom.
- Remove the `Coding Conventions` section from http://mythryl.org/ and put those links in the new "Best Practices" page.
- Add a new link on that "Best Practices" page, and write about the above-mentioned curly braces practice.