From: Ben Beltran Date: Sat, 5 Sep 2015 22:34:37 +0000 (-0500) Subject: Slight changes to the opening paragraph X-Git-Url: https://git.r.bdr.sh/rbdr/r.bdr.sh/commitdiff_plain/14163c32c52a88021d926f34006ecfb3d8ea7d24 Slight changes to the opening paragraph --- diff --git a/jekyll/_posts/2015-09-05-api-notation.md b/jekyll/_posts/2015-09-05-api-notation.md index 52e2fc8..e482bb5 100644 --- a/jekyll/_posts/2015-09-05-api-notation.md +++ b/jekyll/_posts/2015-09-05-api-notation.md @@ -8,7 +8,7 @@ description: "API notation is a simple way to document the public contract of your componentsA" --- -When writing specifications and trying to figure out how components will interact, an important part is to define the public API as the contract others can depend on: So if you have a complex feature where several people are collaborating, you can ease up the integration woes by properly defining the contract they'll be using to communicate. This means that I usually end up having to write APIs in text files constantly, and over the years I've come up with a notation for this. +When writing specifications and trying to figure out how components will interact, an important part of my workflow is to define the public API as the contract others can depend on: So if we have a complex feature where several people are collaborating, we can ease up the integration woes by properly defining the methods, properties and events they'll be using to communicate. This means that I usually end up having to write APIs in spec files constantly, and over the years I've been using and developing a notation for this. The API notation is very simple and encodes what public properties, methods and events an object/class provides. It looks like this: @@ -44,4 +44,4 @@ If you do decide to give it a try, let me know how it works out for you and if t [vim]: https://github.com/rbdr/api-notation.vim [atom]: https://github.com/rbdr/api-notation-atom -[sublime]: https://github.com/rbdr/api-notation.tmLanguage \ No newline at end of file +[sublime]: https://github.com/rbdr/api-notation.tmLanguage