19 Matching Annotations
- Jan 2024
-
style.tidyverse.org style.tidyverse.org
-
Place a space before and after () when used with if, for, or while.
-
-
style.tidyverse.org style.tidyverse.org
-
In code, use comments to explain the “why” not the “what” or “how”.
Tags
Annotators
URL
-
- Dec 2022
-
www.colorado.edu www.colorado.edu
-
Editorial Style Guide
CU Boulder style guide
-
- Aug 2022
-
-
2012. Microsoft Writing Style Guide. https://docs.microsoft.com/en-us/style-guide/welcome/.
Other recommendable technical–writing style guides:
- Google developer documentation style guide
- Apple Style Guide
- Write the Docs, Accessibility guidelines
- Write the Docs, Reducing bias in your writing
- IBM developerWorks Editorial style guide
- Red Hat Technical Writing Style Guide
- Splunk Style Guide
- DigitalOcean Documentation Style Guide
- Salesforce Style Guide for Documentation and User Interface Text
- Rackspace Writing guidelines
- OpenStack Writing style
- MongoDB Documentation Style Guide
- Conscious Style Guide
- 18F Content Guide
- A11Y Style Guide
- Mailchimp Content Style Guide
Tags
Annotators
URL
-
- Mar 2022
-
docs.google.com docs.google.com
-
EDUCAUSE Inclusive Language Guide
-
- Jun 2021
-
github.com github.com
-
docs.microsoft.com docs.microsoft.com
-
Enter Instructing the customer to type or otherwise insert a value, or to type or select a value in a combo box.
-
- Apr 2021
-
medium.com medium.com
-
“Who cares? Let’s just go with the style-guide” — to which my response is that caring about the details is in the heart of much of our doings. Yes, this is not a major issue; def self.method is not even a code smell. Actually, that whole debate is on the verge of being incidental. Yet the learning process and the gained knowledge involved in understanding each choice is alone worth the discussion. Furthermore, I believe that the class << self notation echoes a better, more stable understanding of Ruby and Object Orientation in Ruby. Lastly, remember that style-guides may change or be altered (carefully, though!).
-
Similarly to fashion, code style reflects our credo as developers, our values and philosophy.
-
Yet, it certainly is important to make the proper choices when picking up style. Similarly to fashion, code style reflects our credo as developers, our values and philosophy. In order to make an informed decision, it’s mandatory to understand the issue at stake well. We all have defined class methods many times, but do we really know how do they work?
Tags
- intentional/well-considered decisions
- good point
- readability
- ideology/philosophy
- try to do it the best possible way
- code style guide
- can be changed
- core/guiding beliefs/values/principles/philosophy/ideology
- caring about the details
- values
- reversible decisions
- I agree
- investing time to really understand something
- understand the ramifications/effects/consequences
- defending an idea
- core values
Annotators
URL
-
-
docs.microsoft.com docs.microsoft.com
-
The best procedure is the one you don’t need. If the UI is crystal clear and leads the customer through a task, a procedure isn’t necessary. Start there.
-
-
english.stackexchange.com english.stackexchange.com
-
I actually think this is Not Constructive, since there's no absolute rule about which pairings can be joined into a single word or hyhenated, and it's pointless having "votes" here about each specific case. Follow a style guide if you have one, or search Google Books and copy whatever the majority do. Or just make your own decision.
-
- Dec 2020
-
docs.microsoft.com docs.microsoft.com
-
Include articles, such as the. Articles help readers and translation software identify the nouns and modifiers in a sentence. Examples Empty the container. The empty container
-
-
docs.microsoft.com docs.microsoft.com
-
Use display as a general term for any visual output device, including the built-in display on a computing device and an external monitor or projector.
-
-
docs.microsoft.com docs.microsoft.com
-
To open the document in Outline view, select View > Outline.
-
On the Font tab, choose the effects you want.
-
- Oct 2020
-
www.python.org www.python.org
-
However, know when to be inconsistent -- sometimes style guide recommendations just aren't applicable.
-
- Aug 2019
- Jan 2017