Docs review #72
Docs review #72
Conversation
api-reference/connect.md
Outdated
| | `ConnectionError` | Gets thrown if the connection fails. | | ||
| | Type | Description | | ||
| | :--------------------- | :----------------------------------------------------- | | ||
| | `ConnectionError` | Gets thrown if the connection fails. | |
There was a problem hiding this comment.
We don't have support for Errors yet. Should we include a quick PR to include them or remove this from the documentation for now?
There was a problem hiding this comment.
I think we could try to add proper errors (I am thinking in particular about OrganizationNotFound which is very common), and we could remove them just before releasing if we are not ready.
There was a problem hiding this comment.
I agree we should include at least a handler for OrganizationNotFound . But let's do it in a different PR.
Codecov Report
@@ Coverage Diff @@
## master #72 +/- ##
==========================================
- Coverage 29.10% 28.99% -0.11%
==========================================
Files 53 53
Lines 835 838 +3
Branches 135 137 +2
==========================================
Hits 243 243
- Misses 592 595 +3
Continue to review full report at Codecov.
|
api-reference/organization.md
Outdated
| @@ -8,149 +8,149 @@ An `Organization` instance represents an Aragon organization and allows to inter | |||
|
|
|||
There was a problem hiding this comment.
We still don't have support for several of the API methods on this document. Should we remove them from the docs now?
There was a problem hiding this comment.
Sure yes, we could have these in a next branch maybe? That branch would contain any code or documentation that is not ready to be released yet.
There was a problem hiding this comment.
Is this still necessary with our current GitBook setup?
I will go ahead and give a stab to include the few API methods we miss. I believe we already have all the logic we need.
api-reference/organization.md
Outdated
| @@ -8,149 +8,149 @@ An `Organization` instance represents an Aragon organization and allows to inter | |||
|
|
|||
There was a problem hiding this comment.
Sure yes, we could have these in a next branch maybe? That branch would contain any code or documentation that is not ready to be released yet.
Note I did a first commit where I included lint to the markdown files. The actual documentation changes are on this commit: 3a32151