Comments (3)
I read the guideline again after seeing this issue and I'm inclined to agree.
- The table of contents itself is inconsistent with casing.
- All caps has actual meanings in the actual guideline both as technical words: e.g. REST, RESTful, HTTPS, OPTIONS
- And as part of the requirements language https://github.com/Microsoft/api-guidelines/blob/master/Guidelines.md#43-requirements-language "MUST, SHOULD, SHOULD NOT"
So the liberal use of all capital case in headings distracts from the use in the rest of the text. In fact, it is much hard to see "SHOULD, SHOULD NOT" with all the headings capitalized and that's when I feel the issue has crossed the line from trivial to important.
Please consider dropping all caps in the headings.
from api-guidelines.
Thanks for the suggestions @lumaxis and @johnnliu.
I believe this is just a remnant from when we converted the guidelines into Markdown.
Anyone wanting to submit a pull request to fix these from ALL CAPS would be appreciated.
from api-guidelines.
@BasThomas PR, found here, addresses most of this.
As soon as I get get another set of eyes on it, I'll merge it in. #26
from api-guidelines.
Related Issues (20)
- Viewpoint pattern
- Large File Upload Pattern
- Complex type pattern
- Delete pattern
- State machine pattern HOT 1
- Throttling pattern
- Graph specific HTTP Request/Response
- Shared Type Design Pattern
- HTTP Return Codes don't mention HTTP HEAD HOT 8
- Vanity url is broken with leading slash HOT 2
- Guidance on response payload with 201
- arbitrary JSON pattern/anti-pattern
- Add guidance for pageable post operations
- Fix content table in the main Graph guidelines. merger enum and evolvable enum patterns
- querying arbitrary number of keys in a dictionary insted HOT 1
- Add clarity to expand requirement
- The 'at' naming convention
- Xbox box 360 live
- Vague guidelines about point query support
- Error message localization HOT 1
Recommend Projects
-
React
A declarative, efficient, and flexible JavaScript library for building user interfaces.
-
Vue.js
🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
-
Typescript
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
-
TensorFlow
An Open Source Machine Learning Framework for Everyone
-
Django
The Web framework for perfectionists with deadlines.
-
Laravel
A PHP framework for web artisans
-
D3
Bring data to life with SVG, Canvas and HTML. 📊📈🎉
-
Recommend Topics
-
javascript
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
-
web
Some thing interesting about web. New door for the world.
-
server
A server is a program made to process requests and deliver data to clients.
-
Machine learning
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
-
Visualization
Some thing interesting about visualization, use data art
-
Game
Some thing interesting about game, make everyone happy.
Recommend Org
-
Facebook
We are working to build community through open source technology. NB: members must have two-factor auth.
-
Microsoft
Open source projects and samples from Microsoft.
-
Google
Google ❤️ Open Source for everyone.
-
Alibaba
Alibaba Open Source for everyone
-
D3
Data-Driven Documents codes.
-
Tencent
China tencent open source team.
from api-guidelines.