From 7ddaa4614bfd5ed1c444c885b5acdaa4d607c706 Mon Sep 17 00:00:00 2001 From: Victor Woeltjen Date: Fri, 14 Aug 2015 12:23:11 -0700 Subject: [PATCH] [API] Fix markdown formatting --- docs/src/design/proposals/APIRedesign.md | 24 ++++++++++++------------ 1 file changed, 12 insertions(+), 12 deletions(-) diff --git a/docs/src/design/proposals/APIRedesign.md b/docs/src/design/proposals/APIRedesign.md index f1bf359cec..145301415d 100644 --- a/docs/src/design/proposals/APIRedesign.md +++ b/docs/src/design/proposals/APIRedesign.md @@ -208,26 +208,26 @@ Other problems: The following attributes of the current API are undesirable: -[ ] It is difficult to tell "where things are" in the code base. -[ ] It is difficult to see how objects are passed around at run-time. -[ ] Multiple interfaces for related concepts (e.g. telemetry) is confusing. -[ ] API documentation is missing or not well-formatted for use. -[ ] High-level separation of concerns is not made clear. -[ ] Interface depth of telemetry API is excessive (esp. `TelemetrySeries`) -[ ] Capabilities as a concept lack clarity. -[ ] Too many interfaces and concepts to learn. +- [ ] It is difficult to tell "where things are" in the code base. +- [ ] It is difficult to see how objects are passed around at run-time. +- [ ] Multiple interfaces for related concepts (e.g. telemetry) is confusing. +- [ ] API documentation is missing or not well-formatted for use. +- [ ] High-level separation of concerns is not made clear. +- [ ] Interface depth of telemetry API is excessive (esp. `TelemetrySeries`) +- [ ] Capabilities as a concept lack clarity. +- [ ] Too many interfaces and concepts to learn. ## Positive Features It is desirable to retain the following features in an API redesign: -[ ] Creating new features and implementing them additively is well-supported. -[ ] Easy to add/remove features which involve multiple concerns. +- [ ] Creating new features and implementing them additively is well-supported. +- [ ] Easy to add/remove features which involve multiple concerns. ## Requirements The following are considered "must-haves" of any complete API redesign: -[ ] Don't require usage of Angular API. -[ ] Don't require support for Angular API. \ No newline at end of file +- [ ] Don't require usage of Angular API. +- [ ] Don't require support for Angular API.