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

refactor docs example table outputs #110

Open
CrepeGoat opened this issue Dec 17, 2021 · 0 comments
Open

refactor docs example table outputs #110

CrepeGoat opened this issue Dec 17, 2021 · 0 comments
Labels
documentation Improvements or additions to documentation

Comments

@CrepeGoat
Copy link
Contributor

Copied & edited from #107

Some of the pandas DataFrame outputs in the docs have a lack of visual distinction between the table's formatting and the pain text formatting. E.g., in the below snippet from the docs (see the section "endaq.ide Usage Examples"), the last line "The results can be filtered by measurement type:" bleeds together with the table above it:

image

Instead, that table could be included in a pycon block, so that the command and it's output are both stylistically wrapped in a code-style block. (This done in the pandas docs quite a bit, though the tables tend to be smaller which may make this technique more feasible in their case.)

Using a pycon block would look something like this in the docstrings:

.. code:: pycon

    >>> get_channel_table(doc)
    ...
@CrepeGoat CrepeGoat added the documentation Improvements or additions to documentation label Dec 17, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

1 participant