Skip to content

Commit e3f52dc

Browse files
committed
[#232] Remove first-person references
Let's adopt language that reflects better the community-driven nature of the guide.
1 parent 32c5748 commit e3f52dc

File tree

1 file changed

+11
-12
lines changed

1 file changed

+11
-12
lines changed

README.adoc

+11-12
Original file line numberDiff line numberDiff line change
@@ -26,13 +26,12 @@ programmers. A style guide that reflects real-world usage gets used, and a
2626
style guide that holds to an ideal that has been rejected by the people it is
2727
supposed to help risks not getting used at all -- no matter how good it is.
2828

29-
The guide is separated into several sections of related rules. I've
30-
tried to add the rationale behind the rules (if it's omitted, I've
29+
The guide is separated into several sections of related rules. we've
30+
tried to add the rationale behind the rules (if it's omitted, we've
3131
assumed that it's pretty obvious).
3232

33-
I didn't come up with all the rules out of nowhere; they are mostly
34-
based on my extensive career as a software engineer,
35-
my work on many Clojure open-source projectsfootnote:[CIDER, nREPL, Orchard, etc.],
33+
We didn't come up with all the rules out of nowhere; they are mostly
34+
based on the experience of the style guide's editors,
3635
feedback and suggestions from numerous members of the Clojure community, and
3736
various highly regarded Clojure programming resources, such as
3837
https://www.clojurebook.com/["Clojure Programming"]
@@ -82,24 +81,24 @@ ____
8281

8382
It's common knowledge that code is read much more often than it is written.
8483
The guidelines provided here are intended to improve the readability of code and make it consistent across the wide spectrum of Clojure code.
85-
They are also meant to reflect real-world usage of Clojure instead of a random ideal. When I had to choose between a very established practice
86-
and a subjectively better alternative I've opted to recommend the established practice.footnote:[Occasionally I might suggest to the reader to consider some alternatives, though.]
84+
They are also meant to reflect real-world usage of Clojure instead of a random ideal. When we had to choose between a very established practice
85+
and a subjectively better alternative we've opted to recommend the established practice.footnote:[Occasionally we might suggest to the reader to consider some alternatives, though.]
8786

8887
There are some areas in which there is no clear consensus in the Clojure community regarding a particular style (like semantic indentation vs fixed indentation, semantic comments vs uniform comments, etc).
8988
In such scenarios all popular styles are acknowledged and it's up to you to pick one and apply it consistently.
9089

9190
Fortunately Clojure is a Lisp, and Lisps are fundamentally
9291
simple. Even though this guide was created a few years after Clojure
93-
(I published the first version in early 2013), you could see that most
94-
Clojure code in the wild was fairly uniform. I attribute this to
95-
both the simplicity I already mentioned and to the fact that since day
92+
(the first version was published in early 2013), you could see that most
93+
Clojure code in the wild was fairly uniform. We attribute this to
94+
both the simplicity we already mentioned and to the fact that since day
9695
1 Clojurists adopted many of the style conventions of other
9796
established Lisp dialects (e.g. Common Lisp and Scheme). This made
9897
the work on this guide fairly easy and straight-forward, especially compared to
9998
the massive exercise in frustration that was the
10099
https://rubystyle.guide[Community Ruby Style Guide].footnote:[You'll notice that the Clojure style guide is pretty similar in structure to the Ruby style guide, which served as its main source of inspiration. You'll also notice that the Ruby style guide is much longer, mostly because of the complexity of the Ruby language.]
101100

102-
Clojure is famously optimized for simplicity and clarity. I'd like to believe that this guide is going to help you optimize for maximum
101+
Clojure is famously optimized for simplicity and clarity. We'd like to believe that this guide is going to help you optimize for maximum
103102
simplicity and clarity.
104103

105104
=== A Note About Consistency
@@ -807,7 +806,7 @@ You might have noticed that those are a bit inconsistent:
807806
* `clojure.walk` becomes `walk`
808807
* `clojure.spec.alpha` becomes `spec`
809808

810-
I guess it's clear that the one thing they have in common is that they aim to be concise, but still carry some meaning (aliasing `clojure.walk` to `w` would
809+
It's clear that the one thing they have in common is that they aim to be concise, but still carry some meaning (aliasing `clojure.walk` to `w` would
811810
be concise, but won't carry much meaning).
812811

813812
But what to do about all the other namespaces out there that don't have idiomatic aliases? Well, you better be consistent in your approach to deriving aliases for them,

0 commit comments

Comments
 (0)