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

Documentation convention for marking unstable APIs. #1202

Closed
simonw opened this issue Jan 24, 2021 · 2 comments
Closed

Documentation convention for marking unstable APIs. #1202

simonw opened this issue Jan 24, 2021 · 2 comments

Comments

@simonw
Copy link
Owner

simonw commented Jan 24, 2021

I'm going to document this but mark it as unstable, using a new documentation convention for marking unstable APIs.

Originally posted by @simonw in #1154 (comment)

@simonw simonw added this to the Datasette 0.54 milestone Jan 24, 2021
@simonw
Copy link
Owner Author

simonw commented Jan 24, 2021

Can use an "admonition" similar to this:

.. warning::
    Restricting access to tables and views in this way will NOT prevent users from querying them using arbitrary SQL queries, `like this <https://latest.datasette.io/fixtures?sql=select+*+from+facetable>`__ for example.

As seen on https://docs.datasette.io/en/stable/authentication.html#controlling-access-to-specific-tables-and-views

Documentation: https://docutils.sourceforge.io/docs/ref/rst/directives.html#specific-admonitions

@simonw
Copy link
Owner Author

simonw commented Jan 25, 2021

I'm going to use the existing .. warning:: pattern for this.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

1 participant