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

Doctest tutorials/rest-api.md #153

Closed
pavithraes opened this issue Nov 2, 2023 · 1 comment
Closed

Doctest tutorials/rest-api.md #153

pavithraes opened this issue Nov 2, 2023 · 1 comment
Labels
area: documentation 📖 Improvements or additions to documentation type: maintenance 🛠️ Day-to-day maintenance tasks

Comments

@pavithraes
Copy link
Member

pavithraes commented Nov 2, 2023

Tracking:
https://github.com/Quansight/ragna/pull/151/files#diff-5c6dddc0c85981eb75bdb49d400e82c9271918e138990baba53ac34cbcf2aaacR9-R14

    # FIXME: The REST API tutorial uses await outside sync functions
    # this would work in a Jupyter Notebook, but not in a Python script
    # We'll also need to have the API running to test this properly.
    if fpath == pathlib.Path("docs/tutorials/rest-api.md"):
        with pytest.raises(SyntaxError, match="'await' outside function"):
            check_md_file(fpath=fpath, memory=True)
@pavithraes pavithraes added area: documentation 📖 Improvements or additions to documentation type: maintenance 🛠️ Day-to-day maintenance tasks labels Nov 2, 2023
@pavithraes pavithraes mentioned this issue Nov 2, 2023
3 tasks
@pmeier
Copy link
Member

pmeier commented Mar 18, 2024

Closing this since we no longer need doc tests for the tutorials and examples after #89.

@pmeier pmeier closed this as completed Mar 18, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area: documentation 📖 Improvements or additions to documentation type: maintenance 🛠️ Day-to-day maintenance tasks
Projects
None yet
Development

No branches or pull requests

2 participants