home / github

Menu
  • GraphQL API

issue_comments

Table actions
  • GraphQL API for issue_comments

13 rows where issue = 779691739

✎ View and edit SQL

This data as json, CSV (advanced)

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

id ▼ html_url issue_url node_id user created_at updated_at author_association body reactions issue performed_via_github_app
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  
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  
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  
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  
755159583 https://github.com/simonw/datasette/issues/1176#issuecomment-755159583 https://api.github.com/repos/simonw/datasette/issues/1176 MDEyOklzc3VlQ29tbWVudDc1NTE1OTU4Mw== simonw 9599 2021-01-06T08:28:20Z 2021-01-06T08:28:20Z OWNER I used `from datasette.utils import path_with_format` in https://github.com/simonw/datasette-export-notebook/blob/0.1/datasette_export_notebook/__init__.py just now. {"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  
969616626 https://github.com/simonw/datasette/issues/1176#issuecomment-969616626 https://api.github.com/repos/simonw/datasette/issues/1176 IC_kwDOBm6k_c45yyzy simonw 9599 2021-11-16T01:29:13Z 2021-11-16T01:29:13Z OWNER I'm inclined to create a Sphinx reference documentation page for this, as I did for `sqlite-utils` here: https://sqlite-utils.datasette.io/en/stable/reference.html {"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  
1030762279 https://github.com/simonw/datasette/issues/1176#issuecomment-1030762279 https://api.github.com/repos/simonw/datasette/issues/1176 IC_kwDOBm6k_c49cC8n simonw 9599 2022-02-06T06:38:08Z 2022-02-06T06:41:37Z OWNER Might do this using Sphinx auto-generated function and class documentation hooks, as seen here in `sqlite-utils`: https://sqlite-utils.datasette.io/en/stable/python-api.html#spatialite-helpers This would encourage me to add really good docstrings. ``` .. _python_api_gis_find_spatialite: Finding SpatiaLite ------------------ .. autofunction:: sqlite_utils.utils.find_spatialite ``` {"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  
1031108559 https://github.com/simonw/datasette/issues/1176#issuecomment-1031108559 https://api.github.com/repos/simonw/datasette/issues/1176 IC_kwDOBm6k_c49dXfP simonw 9599 2022-02-07T06:11:27Z 2022-02-07T06:11:27Z OWNER I'm going with `@documented` as the decorator for functions that should be documented. {"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  
1031122800 https://github.com/simonw/datasette/issues/1176#issuecomment-1031122800 https://api.github.com/repos/simonw/datasette/issues/1176 IC_kwDOBm6k_c49da9w simonw 9599 2022-02-07T06:34:21Z 2022-02-07T06:34:21Z OWNER New section is here: https://docs.datasette.io/en/latest/internals.html#the-datasette-utils-module But it's not correctly displaying the new autodoc stuff: <img width="688" alt="image" src="https://user-images.githubusercontent.com/9599/152736915-e6470e0a-05e2-4612-a2ff-ebd4f51b65cb.png"> {"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  
1031123719 https://github.com/simonw/datasette/issues/1176#issuecomment-1031123719 https://api.github.com/repos/simonw/datasette/issues/1176 IC_kwDOBm6k_c49dbMH simonw 9599 2022-02-07T06:36:32Z 2022-02-07T06:36:32Z OWNER https://github.com/simonw/sqlite-utils/blob/main/.readthedocs.yaml looks like this (it works correctly): ```yaml version: 2 sphinx: configuration: docs/conf.py python: version: "3.8" install: - method: pip path: . extra_requirements: - docs ``` Compare to the current Datasette one here: https://github.com/simonw/datasette/blob/d9b508ffaa91f9f1840b366f5d282712d445f16b/.readthedocs.yaml#L1-L13 Looks like I need this bit: ```python python: version: "3.8" install: - method: pip path: . extra_requirements: - docs ``` {"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  
1031125347 https://github.com/simonw/datasette/issues/1176#issuecomment-1031125347 https://api.github.com/repos/simonw/datasette/issues/1176 IC_kwDOBm6k_c49dblj simonw 9599 2022-02-07T06:40:16Z 2022-02-07T06:40:16Z OWNER Read The Docs error: > Problem in your project's configuration. Invalid "python.version": .readthedocs.yaml: Invalid configuration option: python.version. Make sure the key name is correct. {"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  
1031126547 https://github.com/simonw/datasette/issues/1176#issuecomment-1031126547 https://api.github.com/repos/simonw/datasette/issues/1176 IC_kwDOBm6k_c49db4T simonw 9599 2022-02-07T06:42:58Z 2022-02-07T06:42:58Z OWNER That fixed it: https://docs.datasette.io/en/latest/internals.html#parse-metadata-content <img width="695" alt="image" src="https://user-images.githubusercontent.com/9599/152737872-595e9a14-1a0d-47ff-9509-63ee765c0c5d.png"> {"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  
1031126801 https://github.com/simonw/datasette/issues/1176#issuecomment-1031126801 https://api.github.com/repos/simonw/datasette/issues/1176 IC_kwDOBm6k_c49db8R simonw 9599 2022-02-07T06:43:31Z 2022-02-07T06:43:31Z OWNER Here's the new test: https://github.com/simonw/datasette/blob/03305ea183b1534bc4cef3a721fe5f3700273b84/tests/test_docs.py#L91-L104 {"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]);
Powered by Datasette · Queries took 20.869ms · About: simonw/datasette-graphql