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

Include ListViewDataSource docs somewhere #410

Closed
glenjamin opened this issue Mar 28, 2015 · 19 comments · Fixed by #702
Closed

Include ListViewDataSource docs somewhere #410

glenjamin opened this issue Mar 28, 2015 · 19 comments · Fixed by #702
Labels
Good first issue Interested in collaborating? Take a stab at fixing one of these issues. Help Wanted :octocat: Issues ideal for external contributors. Resolution: Locked This issue was locked by the bot.

Comments

@glenjamin
Copy link

I guess ideally they should be on the ListView page?

The docblocks in https://github.com/facebook/react-native/blob/master/Libraries/CustomComponents/ListView/ListViewDataSource.js seem fairly complete, I just can't find the info on the docs site.

@pjjanak
Copy link

pjjanak commented Mar 29, 2015

Would be resolve by PR #360

vjeux added a commit to vjeux/react-native that referenced this issue Apr 6, 2015
- [ReactNative] Revert D1965911 | Christopher Chedeau
- [ReactNative] Remove experimental Portal only needed for android right now. | Spencer Ahrens
- [ReactNative] rename Animation to AnimationExperimental with warning docs | Spencer Ahrens
- navigator.getCurrentRoutes() | Eric Vicenti
- Fixing jsdoc parsing of functions that are defined over multiple lines (Fixes facebook#410) | Christopher Chedeau
- Added constraint of child type to touchablewithoutfeedback | Christopher Chedeau
- [react-packager] Deprecate global image namespace in favor of CommonJS resolution | Amjad Masad
- [react-packager] Don't cache rejected promise | Amjad Masad
- [ReactNative] Start Navigator gesture config, disable gesture in AdsManager | Eric Vicenti
- [Flow] Clean react-native-github for Flow v0.8.0 | Gabe Levi
- add maximumValue and minimumValue as valid attributes for native Slider | Christopher Chedeau
- react-packager: Add ES6 import statement support to DependencyGraph. | Amjad Masad
- Remove false annotation | Christopher Chedeau
- [madman] prevent pulling the content down inconsistently when the keyboard shows up | Kevin Gozali
- add @flow back to View.js | Basil Hosmer
- [ReactNative] Turn of lint warning for constant conditions | Eric Vicenti
- [UIExplorer] Fixed 'Push View Example' in NavigatorIOS example | Christopher Chedeau
- SliderIOS.js comments - grammar correction | Christopher Chedeau
@vjeux vjeux closed this as completed in #702 Apr 6, 2015
vjeux pushed a commit to vjeux/react-native that referenced this issue Apr 13, 2015
Fixes facebook#410)

Summary:
As it was implemented, the jsdoc parser would look only the first non-blank line immediately preceding a function declaration. However, the line that was set as the beginning of a function declaration was where the opening bracket (`{`) was. This is insufficient for functions whose definitions span multiple lines. For example, this declaration would not find the comments above it:

```
/**
 * Clones rows
 **/
cloneWithRows(
       dataBlob: Array<any> | {[key: string]: any},
       rowIdentities: ?Array<string>
   ): ListViewDataSource {
...
}
```

With this change, the parser will first check if we have a closing parenthesis. If we do and don't have a matching open parenthesis we continue moving up the lines until we find it. Then we set previous line to be the line before that, the true beginning of the function declaration.
Closes facebook#360
Github Author: Peter Janak <[email protected]>

Test Plan: Run the website
vjeux pushed a commit to vjeux/react-native that referenced this issue Apr 14, 2015
Fixes facebook#410)

Summary:
As it was implemented, the jsdoc parser would look only the first non-blank line immediately preceding a function declaration. However, the line that was set as the beginning of a function declaration was where the opening bracket (`{`) was. This is insufficient for functions whose definitions span multiple lines. For example, this declaration would not find the comments above it:

```
/**
 * Clones rows
 **/
cloneWithRows(
       dataBlob: Array<any> | {[key: string]: any},
       rowIdentities: ?Array<string>
   ): ListViewDataSource {
...
}
```

With this change, the parser will first check if we have a closing parenthesis. If we do and don't have a matching open parenthesis we continue moving up the lines until we find it. Then we set previous line to be the line before that, the true beginning of the function declaration.
Closes facebook#360
Github Author: Peter Janak <[email protected]>

Test Plan: Run the website
vjeux pushed a commit to vjeux/react-native that referenced this issue Apr 15, 2015
Fixes facebook#410)

Summary:
As it was implemented, the jsdoc parser would look only the first non-blank line immediately preceding a function declaration. However, the line that was set as the beginning of a function declaration was where the opening bracket (`{`) was. This is insufficient for functions whose definitions span multiple lines. For example, this declaration would not find the comments above it:

```
/**
 * Clones rows
 **/
cloneWithRows(
       dataBlob: Array<any> | {[key: string]: any},
       rowIdentities: ?Array<string>
   ): ListViewDataSource {
...
}
```

With this change, the parser will first check if we have a closing parenthesis. If we do and don't have a matching open parenthesis we continue moving up the lines until we find it. Then we set previous line to be the line before that, the true beginning of the function declaration.
Closes facebook#360
Github Author: Peter Janak <[email protected]>

Test Plan: Run the website
@Crash--
Copy link
Contributor

Crash-- commented Sep 18, 2015

I think there is a regression here. I can't find the documentation about ListViewDataSource on the ListView page (https://facebook.github.io/react-native/docs/listview.html#datasource)

@satya164
Copy link
Contributor

Same here. ListViewDataSourcedocs will be awesome to have.

@TiagoGouvea
Copy link

Needing too.

@mikedizon
Copy link

+1

2 similar comments
@thunderousNinja
Copy link

👍

@wootwoot1234
Copy link

+1

@vjeux
Copy link
Contributor

vjeux commented Oct 29, 2015

cc @MartinKonicek

@vjeux
Copy link
Contributor

vjeux commented Oct 29, 2015

cc @mkonicek

@jordaaash
Copy link

+1

1 similar comment
@tomauty
Copy link
Contributor

tomauty commented Jan 7, 2016

+1

@appden
Copy link
Contributor

appden commented Feb 20, 2016

These docs are still missing.

@crockpotveggies
Copy link

+1

4 similar comments
@tkmoney
Copy link

tkmoney commented Mar 14, 2016

+1

@sjchmiela
Copy link
Contributor

+1

@MichaelDanielTom
Copy link

+1

@rodginez
Copy link

+1

@satya164
Copy link
Contributor

It would be great if somebody could send a PR for this.

@jordaaash
Copy link

#1 result on Google for ListViewDataSource is this issue.
#2 is #1880.
Yep. It would be great if someone who knows how it works could document it.

@satya164 satya164 reopened this Mar 26, 2016
@satya164 satya164 added Good first issue Interested in collaborating? Take a stab at fixing one of these issues. Help Wanted :octocat: Issues ideal for external contributors. labels Mar 26, 2016
@ghost ghost closed this as completed in 7102fd0 Apr 24, 2016
ptmt pushed a commit to ptmt/react-native that referenced this issue May 9, 2016
Summary:Fixes facebook#410
Closes facebook#7193

Differential Revision: D3217718

fb-gh-sync-id: c05c9e3d67863c064f8e1102090614c6ba7e3127
fbshipit-source-id: c05c9e3d67863c064f8e1102090614c6ba7e3127
zebulgar pushed a commit to nightingale/react-native that referenced this issue Jun 18, 2016
Summary:Fixes facebook#410
Closes facebook#7193

Differential Revision: D3217718

fb-gh-sync-id: c05c9e3d67863c064f8e1102090614c6ba7e3127
fbshipit-source-id: c05c9e3d67863c064f8e1102090614c6ba7e3127
samerce pushed a commit to iodine/react-native that referenced this issue Aug 23, 2016
Summary:Fixes facebook#410
Closes facebook#7193

Differential Revision: D3217718

fb-gh-sync-id: c05c9e3d67863c064f8e1102090614c6ba7e3127
fbshipit-source-id: c05c9e3d67863c064f8e1102090614c6ba7e3127
@facebook facebook locked as resolved and limited conversation to collaborators Jul 23, 2018
@react-native-bot react-native-bot added the Resolution: Locked This issue was locked by the bot. label Jul 23, 2018
This issue was closed.
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
Good first issue Interested in collaborating? Take a stab at fixing one of these issues. Help Wanted :octocat: Issues ideal for external contributors. Resolution: Locked This issue was locked by the bot.
Projects
None yet
Development

Successfully merging a pull request may close this issue.