Clarified table documentation with where clause field requirements

turbot · Apr 3, 2021 · d94489e · d94489e
1 parent 64d8531
commit d94489e
Show file tree

Hide file tree

Showing 9 changed files with 27 additions and 18 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,4 +1,11 @@
 
+## v0.0.2 [TBD]
+
+_What's new?_
+
+- Clarified table documentation with where clause field requirements.
+
+
 ## v0.0.1 [2021-04-03]
 
 _What's new?_

diff --git a/docs/index.md b/docs/index.md
@@ -47,13 +47,6 @@ where
 |                     | Changelog – https://t.co/8IETtyFBGZ                 |                 |
 |                     |                                                     |                 |
 |                     | #shiftleftjoin @awscloud https://t.co/o7ifZQlRMe    |                 |
-| 1377723768857104391 | New! Use SQL to instantly query Oracle Cloud 🚀     | ["OracleCloud"] |
-|                     |                                                     |                 |
-|                     | Open source. No DB required.                        |                 |
-|                     |                                                     |                 |
-|                     | #shiftleftjoin @OracleCloud                         |                 |
-|                     |                                                     |                 |
-|                     | https://t.co/Jy9imAz9qK                             |                 |
 +---------------------+-----------------------------------------------------+-----------------+
 ```
 

diff --git a/docs/tables/twitter_search_recent.md b/docs/tables/twitter_search_recent.md
@@ -3,7 +3,7 @@
 Search the last 7 days of public tweets using the [Twitter search syntax and operators](https://developer.twitter.com/en/docs/twitter-api/tweets/search/integrate/build-a-query).
 
 Notes:
-* The `query` field must be provided in the `where` clause.
+* The `query` field must be set in the `where` clause.
 * To prevent excess API quota use, results are limited to `max_results_per_query` by default.
 
 ## Examples

diff --git a/docs/tables/twitter_tweet.md b/docs/tables/twitter_tweet.md
@@ -1,8 +1,12 @@
 # Table: twitter_tweet
 
-Get information about a tweet.
+Get information about a any public tweet.
 
-Note: The `id` field must be provided.
+To query lists of tweets see
+[twitter_search_recent](../twitter_search_recent) or
+[twitter_user_tweet](../twitter_user_tweet) instead.
+
+Note: The `id` field must be set in the `where` clause.
 
 ## Examples
 

diff --git a/docs/tables/twitter_user.md b/docs/tables/twitter_user.md
@@ -1,8 +1,13 @@
 # Table: twitter_user
 
-Get information about a user.
+Get information about a single user.
 
-Note: The `id` (priority) or `username` field must be provided.
+To query lists of users see
+[twitter_user_follower](../twitter_user_follower) or
+[twitter_user_following](../twitter_user_following) or
+[twitter_user_mention](../twitter_user_mention) instead.
+
+Note: The `id` (preferred) or `username` field must be set in the `where` clause.
 
 ## Examples
 

diff --git a/docs/tables/twitter_user_follower.md b/docs/tables/twitter_user_follower.md
@@ -2,7 +2,7 @@
 
 Query users who are followers of the specified user ID.
 
-Note: The `user_id` field must be provided.
+Note: The `user_id` field must be set in the `where` clause.
 
 ## Examples
 

diff --git a/docs/tables/twitter_user_following.md b/docs/tables/twitter_user_following.md
@@ -2,7 +2,7 @@
 
 Query which users the specified user follows.
 
-Note: The `user_id` field must be provided.
+Note: The `user_id` field must be set in the `where` clause.
 
 ## Examples
 

diff --git a/docs/tables/twitter_user_mention.md b/docs/tables/twitter_user_mention.md
@@ -1,8 +1,8 @@
 # Table: twitter_user_mention
 
-Tweets where the user is mentioned.
+Tweets where the specified user is mentioned.
 
-Note: A `user_id` must be provided in all queries to this table.
+Note: The `user_id` field must be set in the `where` clause.
 
 ## Examples
 

diff --git a/docs/tables/twitter_user_tweet.md b/docs/tables/twitter_user_tweet.md
@@ -1,8 +1,8 @@
 # Table: twitter_user_tweet
 
-Tweets published by the author.
+Tweets published by the specified user ID (author).
 
-Note: An `user_id` must be provided in all queries to this table.
+Note: The `user_id` field must be set in the `where` clause.
 
 ## Examples