issue_comments

Table actions

4 rows where "created_at" is on date 2021-01-05, issue = 779691739 and "updated_at" is on date 2021-01-05 sorted by updated_at descending

✎ View and edit SQL

This data as json, CSV (advanced)

Suggested facets: created_at (date), updated_at (date)

user 1

issue 1

  • Policy on documenting "public" datasette.utils functions · 4 ✖

author_association 1

id html_url issue_url node_id user created_at updated_at ▲ author_association body reactions issue performed_via_github_app
754957378 https://github.com/simonw/datasette/issues/1176#issuecomment-754957378 https://api.github.com/repos/simonw/datasette/issues/1176 MDEyOklzc3VlQ29tbWVudDc1NDk1NzM3OA== simonw 9599 2021-01-05T23:12:03Z 2021-01-05T23:12:03Z OWNER

This needs to be done for Datasette 1.0. At the very least I need to ensure it's clear that datasette.utils is not part of the public API unless explicitly marked as such.

 
{
    "total_count": 0,
    "+1": 0,
    "-1": 0,
    "laugh": 0,
    "hooray": 0,
    "confused": 0,
    "heart": 0,
    "rocket": 0,
    "eyes": 0
}
 Policy on documenting "public" datasette.utils functions 779691739  
754952146 https://github.com/simonw/datasette/issues/1176#issuecomment-754952146 https://api.github.com/repos/simonw/datasette/issues/1176 MDEyOklzc3VlQ29tbWVudDc1NDk1MjE0Ng== simonw 9599 2021-01-05T22:57:26Z 2021-01-05T22:57:26Z OWNER

Known public APIs might be worth adding type annotations to as well.

 
{
    "total_count": 0,
    "+1": 0,
    "-1": 0,
    "laugh": 0,
    "hooray": 0,
    "confused": 0,
    "heart": 0,
    "rocket": 0,
    "eyes": 0
}
 Policy on documenting "public" datasette.utils functions 779691739  
754952040 https://github.com/simonw/datasette/issues/1176#issuecomment-754952040 https://api.github.com/repos/simonw/datasette/issues/1176 MDEyOklzc3VlQ29tbWVudDc1NDk1MjA0MA== simonw 9599 2021-01-05T22:57:09Z 2021-01-05T22:57:09Z OWNER

It might be neater to move all of the non-public functions into a separate module - datasette.utils.internal perhaps.

 
{
    "total_count": 0,
    "+1": 0,
    "-1": 0,
    "laugh": 0,
    "hooray": 0,
    "confused": 0,
    "heart": 0,
    "rocket": 0,
    "eyes": 0
}
 Policy on documenting "public" datasette.utils functions 779691739  
754951786 https://github.com/simonw/datasette/issues/1176#issuecomment-754951786 https://api.github.com/repos/simonw/datasette/issues/1176 MDEyOklzc3VlQ29tbWVudDc1NDk1MTc4Ng== simonw 9599 2021-01-05T22:56:27Z 2021-01-05T22:56:43Z OWNER

Idea: introduce a @documented decorator which marks specific functions as part of the public, documented API. The unit tests can then confirm that anything with that decorator is both documented and tested. python @documented def escape_css_string(s): return _css_re.sub( lambda m: "\\" + (f"{ord(m.group()):X}".zfill(6)), s.replace("\r\n", "\n"), ) Or maybe @public?

 
{
    "total_count": 0,
    "+1": 0,
    "-1": 0,
    "laugh": 0,
    "hooray": 0,
    "confused": 0,
    "heart": 0,
    "rocket": 0,
    "eyes": 0
}
 Policy on documenting "public" datasette.utils functions 779691739  

Advanced export

JSON shape: default, array, newline-delimited, object

CSV options: 

CREATE TABLE [issue_comments] (
   [html_url] TEXT,
   [issue_url] TEXT,
   [id] INTEGER PRIMARY KEY,
   [node_id] TEXT,
   [user] INTEGER REFERENCES [users]([id]),
   [created_at] TEXT,
   [updated_at] TEXT,
   [author_association] TEXT,
   [body] TEXT,
   [reactions] TEXT,
   [issue] INTEGER REFERENCES [issues]([id])
, [performed_via_github_app] TEXT);
CREATE INDEX [idx_issue_comments_issue]
                ON [issue_comments] ([issue]);
CREATE INDEX [idx_issue_comments_user]
                ON [issue_comments] ([user]);