-
Notifications
You must be signed in to change notification settings - Fork 12
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Adding basic API documentation for List, String, Number and Boolean #38
Conversation
</button> | ||
``` | ||
|
||
#### `set(obj)` |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
In order for the link to work, I think this needs to match the link above (minus any special characters). So in this case the link is [set(object)](#setvalue)
and the heading is set(obj)
A good match might be [set(object)](#setobject)
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Should be fixed.
|
||
### `List` | ||
|
||
List microstate represents an indexed array of values. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I don't think we have an API currently for accessing values by index do we? I'd say the main thing about lists is that they're an ordered collection.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Yep, updated.
#### `concat(list)` | ||
|
||
Merges given array with existing list. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Is merge really the right word here? Seems like what's happening is that we're making a new list with all of the items from list
added to the end of the current list.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Yeah, making a new list with all of the items from list added to the end of the current list
is a better description. I updated to use that description for all list transitions.
@cowboyd should be good to go. |
Closes #25, #24, #26, #27