{"html_url": "https://github.com/simonw/datasette/issues/1176#issuecomment-755159583", "issue_url": "https://api.github.com/repos/simonw/datasette/issues/1176", "id": 755159583, "node_id": "MDEyOklzc3VlQ29tbWVudDc1NTE1OTU4Mw==", "user": {"value": 9599, "label": "simonw"}, "created_at": "2021-01-06T08:28:20Z", "updated_at": "2021-01-06T08:28:20Z", "author_association": "OWNER", "body": "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.", "reactions": "{\"total_count\": 0, \"+1\": 0, \"-1\": 0, \"laugh\": 0, \"hooray\": 0, \"confused\": 0, \"heart\": 0, \"rocket\": 0, \"eyes\": 0}", "issue": {"value": 779691739, "label": "Policy on documenting \"public\" datasette.utils functions"}, "performed_via_github_app": null}
{"html_url": "https://github.com/simonw/datasette/issues/1176#issuecomment-754957378", "issue_url": "https://api.github.com/repos/simonw/datasette/issues/1176", "id": 754957378, "node_id": "MDEyOklzc3VlQ29tbWVudDc1NDk1NzM3OA==", "user": {"value": 9599, "label": "simonw"}, "created_at": "2021-01-05T23:12:03Z", "updated_at": "2021-01-05T23:12:03Z", "author_association": "OWNER", "body": "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.", "reactions": "{\"total_count\": 0, \"+1\": 0, \"-1\": 0, \"laugh\": 0, \"hooray\": 0, \"confused\": 0, \"heart\": 0, \"rocket\": 0, \"eyes\": 0}", "issue": {"value": 779691739, "label": "Policy on documenting \"public\" datasette.utils functions"}, "performed_via_github_app": null}
{"html_url": "https://github.com/simonw/datasette/issues/1176#issuecomment-754952146", "issue_url": "https://api.github.com/repos/simonw/datasette/issues/1176", "id": 754952146, "node_id": "MDEyOklzc3VlQ29tbWVudDc1NDk1MjE0Ng==", "user": {"value": 9599, "label": "simonw"}, "created_at": "2021-01-05T22:57:26Z", "updated_at": "2021-01-05T22:57:26Z", "author_association": "OWNER", "body": "Known public APIs might be worth adding type annotations to as well.", "reactions": "{\"total_count\": 0, \"+1\": 0, \"-1\": 0, \"laugh\": 0, \"hooray\": 0, \"confused\": 0, \"heart\": 0, \"rocket\": 0, \"eyes\": 0}", "issue": {"value": 779691739, "label": "Policy on documenting \"public\" datasette.utils functions"}, "performed_via_github_app": null}
{"html_url": "https://github.com/simonw/datasette/issues/1176#issuecomment-754952040", "issue_url": "https://api.github.com/repos/simonw/datasette/issues/1176", "id": 754952040, "node_id": "MDEyOklzc3VlQ29tbWVudDc1NDk1MjA0MA==", "user": {"value": 9599, "label": "simonw"}, "created_at": "2021-01-05T22:57:09Z", "updated_at": "2021-01-05T22:57:09Z", "author_association": "OWNER", "body": "It might be neater to move all of the non-public functions into a separate module - `datasette.utils.internal` perhaps.", "reactions": "{\"total_count\": 0, \"+1\": 0, \"-1\": 0, \"laugh\": 0, \"hooray\": 0, \"confused\": 0, \"heart\": 0, \"rocket\": 0, \"eyes\": 0}", "issue": {"value": 779691739, "label": "Policy on documenting \"public\" datasette.utils functions"}, "performed_via_github_app": null}
{"html_url": "https://github.com/simonw/datasette/issues/1176#issuecomment-754951786", "issue_url": "https://api.github.com/repos/simonw/datasette/issues/1176", "id": 754951786, "node_id": "MDEyOklzc3VlQ29tbWVudDc1NDk1MTc4Ng==", "user": {"value": 9599, "label": "simonw"}, "created_at": "2021-01-05T22:56:27Z", "updated_at": "2021-01-05T22:56:43Z", "author_association": "OWNER", "body": "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.\r\n```python\r\n@documented\r\ndef escape_css_string(s):\r\n    return _css_re.sub(\r\n        lambda m: \"\\\\\" + (f\"{ord(m.group()):X}\".zfill(6)),\r\n        s.replace(\"\\r\\n\", \"\\n\"),\r\n    )\r\n```\r\nOr maybe `@public`?", "reactions": "{\"total_count\": 0, \"+1\": 0, \"-1\": 0, \"laugh\": 0, \"hooray\": 0, \"confused\": 0, \"heart\": 0, \"rocket\": 0, \"eyes\": 0}", "issue": {"value": 779691739, "label": "Policy on documenting \"public\" datasette.utils functions"}, "performed_via_github_app": null}