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

[Doc] Fix examples and migrate to sphinx doctest (iter/util) #1069

Open
wants to merge 6 commits into
base: main
Choose a base branch
from

Conversation

SvenDS9
Copy link
Contributor

@SvenDS9 SvenDS9 commented Mar 6, 2023

Similar to #901 and as discussed in #850 this migrates examples in iter/util directory to sphinx doctest format.

As sphinx is also able to check normal doctest-style examples (which will be enabled once doctest_test_doctest_blocks = "" is deleted from conf.py), it is not necessary to convert all examples into the testcode/testoutput block format.
However as some tests need to be skipped conditionally, I converted them to block format.

Changes

  • Fixes some faulty examples
  • Migrates many examples in iter/util to testcode/testoutput block format
  • conditionally skip testing some examples
  • use functional form in examples

@facebook-github-bot facebook-github-bot added the CLA Signed This label is managed by the Facebook bot. Authors need to sign the CLA before a PR can be reviewed. label Mar 6, 2023
@SvenDS9
Copy link
Contributor Author

SvenDS9 commented Mar 6, 2023

Using the testcode/testoutput block format the output does look slightly different but imo this it's actually an improvement
grafik

@SvenDS9 SvenDS9 force-pushed the Migrate_to_sphinx_doctest branch from d6aae8f to 438f5a7 Compare March 7, 2023 08:07
@SvenDS9
Copy link
Contributor Author

SvenDS9 commented Mar 8, 2023

I also noticed that many datapipes in util also handle loading so should probably be moved to load.
Imho the division into load, transform and util is fine but is in contrast to the documentation, where we have 10(!) different types.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
CLA Signed This label is managed by the Facebook bot. Authors need to sign the CLA before a PR can be reviewed.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants