Yaltik/hy
2
0
Fork 0
Code Pull Requests Releases Activity

Match heading/subheading style to rest of Hy docs

Browse Source
This commit is contained in:
Kevin Yap 2015-01-02 19:58:46 -08:00
parent a160c74a42
commit 112a075d89
1 changed files with 8 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
docs/style-guide.rst
View File

@ -11,11 +11,12 @@ The Hy style guide intends to be a set of ground rules for the Hyve
to write idiomatic Hy code. Hy derives a lot from Clojure & Common to write idiomatic Hy code. Hy derives a lot from Clojure & Common
Lisp, while always maintaining Python interopability. Lisp, while always maintaining Python interopability.
Prelude Prelude
------- =======
The Tao of Hy The Tao of Hy
~~~~~~~~~~~~~ -------------
:: ::
@ -46,8 +47,9 @@ into the making of Hy.
+ Keep in mind we're not Clojure. We're not Common Lisp. We're + Keep in mind we're not Clojure. We're not Common Lisp. We're
Homoiconic Python, with extra bits that make sense. Homoiconic Python, with extra bits that make sense.
Layout & Indentation Layout & Indentation
-------------------- ====================
+ Avoid trailing spaces. They suck! + Avoid trailing spaces. They suck!
@ -129,7 +131,7 @@ Layout & Indentation
Coding Style Coding Style
------------ ============
+ As a convention, try not to use `def` for other than global + As a convention, try not to use `def` for other than global
variables, use `setv` inside functions,loops etc. variables, use `setv` inside functions,loops etc.
@ -217,7 +219,7 @@ expressions
Conclusion Conclusion
---------- ==========
“Fashions fade, style is eternal” “Fashions fade, style is eternal”
—Yves Saint Laurent —Yves Saint Laurent
@ -230,7 +232,7 @@ about it, tweet about it, and importantly have fun with Hy
Thanks Thanks
------ ======
+ This guide is heavily inspired from `@paultag`_ 's blog post `Hy + This guide is heavily inspired from `@paultag`_ 's blog post `Hy
Survival Guide`_ Survival Guide`_