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

Registry doc cleanup #337

Closed
tomdonaldson opened this issue Jun 3, 2022 · 2 comments
Closed

Registry doc cleanup #337

tomdonaldson opened this issue Jun 3, 2022 · 2 comments

Comments

@tomdonaldson
Copy link
Contributor

A couple items to clean up in the registry rst doc as follow up to #289:

  1. tables = resources[4].get_tables() should get a # doctest: +IGNORE_WARNINGS to ignore unrelated warnings during doctests.
  2. There are 2 "all-VO" queries that appropriately have .. doctest-skip:: since they would take a long time and frequently fail. Since that code is for illustration purposes only, consider:
    • clarifying those limitations with a comment
    • don't skip the example, but modify it to limit its run time and frailty (e.g., limit it to a couple iterations only with a suitable comment on how it would look for all-VO)
@tomdonaldson tomdonaldson added this to the v1.4 milestone Jun 3, 2022
@tomdonaldson tomdonaldson modified the milestones: v1.4, v1.5 Sep 20, 2022
@bsipocz
Copy link
Member

bsipocz commented Sep 21, 2022

The first point has been addressed in #358, and a separate issue #359 has been opened for it (sorry, I didn't see this one in time).

@msdemlei
Copy link
Contributor

Since there's #359, closing this.

@bsipocz bsipocz removed this from the v1.5 milestone Mar 2, 2023
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

3 participants