Comments (1)
Just adding my 2 cents on this: I think self-documenting code (small types, self-explanatory names) is preferable to 100% documentation coverage because every line of documentation becomes a liability for change. And your types and properties and functions sound good to me, so apart from some obviously useful algorithm explanation, documenting each and every property would be overkill.
from notepad.
Related Issues (20)
- Change Markdown syntax colours HOT 3
- Suggestion box is too big HOT 4
- Align text in the centre HOT 2
- Carthage & Swift Package Manager support HOT 6
- Swift 4 support (on CocoaPods)? HOT 3
- 3 spaces make it not working HOT 3
- Internal Protection Level HOT 9
- Line break inside bold or italic markup leaves first part marked up HOT 1
- attribute run ranges are in inconsistent state HOT 2
- Please add the possibility to change the syntax color and clickable links. HOT 4
- macOS pod installation HOT 3
- Issue with Xcode 10.2 HOT 2
- Style boldItalics not rendered correctly HOT 9
- Unable to load your theme file. HOT 11
- Storyboard support HOT 8
- Objective C support HOT 1
- Use System Font HOT 2
- Custom attributes HOT 1
- Placeholder support
- Hide markdown syntax as cursor leaves the position? HOT 4
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 notepad.