You are viewing a plain text version of this content. The canonical link for it is here.
Posted to github@arrow.apache.org by "lidavidm (via GitHub)" <gi...@apache.org> on 2023/06/11 02:06:05 UTC
[GitHub] [arrow-adbc] lidavidm opened a new pull request, #759: docs: add literate-style code recipes
lidavidm opened a new pull request, #759:
URL: https://github.com/apache/arrow-adbc/pull/759
Adds a custom Sphinx directive that generates further reStructuredText markup from a self-contained source file. Appropriately marked comments in the source file are turned into markup, and code in between is turned into code blocks. This lets us author and test recipes using language-native tooling (unlike what the Apache Arrow Cookbook does) but still embed them in a readable way inside the Sphinx documentation.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: github-unsubscribe@arrow.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [arrow-adbc] lidavidm commented on pull request #759: docs: add literate-style code recipes
Posted by "lidavidm (via GitHub)" <gi...@apache.org>.
lidavidm commented on PR #759:
URL: https://github.com/apache/arrow-adbc/pull/759#issuecomment-1587295073
TODO:
- [ ] Add skeleton to run these as unit tests
- [ ] Can we also get them to be output-style? (i.e. like doctests)
- [ ] Can we extend this to cover jshell?
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: github-unsubscribe@arrow.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [arrow-adbc] lidavidm commented on pull request #759: docs: add literate-style code recipes
Posted by "lidavidm (via GitHub)" <gi...@apache.org>.
lidavidm commented on PR #759:
URL: https://github.com/apache/arrow-adbc/pull/759#issuecomment-1585973327
Here's the rendered recipe from this PR:
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: github-unsubscribe@arrow.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [arrow-adbc] lidavidm merged pull request #759: docs: add literate-style code recipes
Posted by "lidavidm (via GitHub)" <gi...@apache.org>.
lidavidm merged PR #759:
URL: https://github.com/apache/arrow-adbc/pull/759
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: github-unsubscribe@arrow.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [arrow-adbc] lidavidm commented on pull request #759: docs: add literate-style code recipes
Posted by "lidavidm (via GitHub)" <gi...@apache.org>.
lidavidm commented on PR #759:
URL: https://github.com/apache/arrow-adbc/pull/759#issuecomment-1588018953
Added several PostgreSQL recipes. I'll probably punt on making these look like doctests. (It doesn't generalize to other languages.) I'll examine Java and C++ in a later PR.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: github-unsubscribe@arrow.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org