Skip to content
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

Merged
merged 4 commits into from
Oct 21, 2016

Conversation

taras
Copy link
Member

@taras taras commented Oct 20, 2016

Closes #25, #24, #26, #27

</button>
```

#### `set(obj)`
Copy link
Member

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)

Copy link
Member Author

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.
Copy link
Member

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.

Copy link
Member Author

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.
Copy link
Member

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.

Copy link
Member Author

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.

@taras
Copy link
Member Author

taras commented Oct 21, 2016

@cowboyd should be good to go.

@cowboyd cowboyd merged commit 88e90de into microstates:master Oct 21, 2016
This was referenced Oct 24, 2016
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants