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

Fix tests formatting in graphs/generators/families.py #31461

Closed
slel opened this issue Mar 7, 2021 · 10 comments
Closed

Fix tests formatting in graphs/generators/families.py #31461

slel opened this issue Mar 7, 2021 · 10 comments

Comments

@slel
Copy link
Member

slel commented Mar 7, 2021

After #30728, some test blocks have TESTS: instead of TESTS::.

The tests in those blocks are in fact never doctested due to that.

CC: @dcoudert @NinaKl @vipul79321 @slel

Component: graph theory

Keywords: tests

Author: David Coudert

Branch/Commit: 4ab1180

Reviewer: Dave Morris

Issue created by migration from https://trac.sagemath.org/ticket/31461

@slel slel added this to the sage-9.3 milestone Mar 7, 2021
@fchapoton
Copy link
Contributor

comment:1

beware of many positive reviewed tickets waiting since 2 months..

@dcoudert
Copy link
Contributor

dcoudert commented Mar 8, 2021

comment:2

we have currently no positive review ticket on families.py
(listing)

@dcoudert
Copy link
Contributor

dcoudert commented Mar 8, 2021

comment:3

But #31436 is waiting for review. :P

@dcoudert
Copy link
Contributor

Author: David Coudert

@dcoudert
Copy link
Contributor

Commit: 4ab1180

@dcoudert
Copy link
Contributor

Branch: public/graphs/31461_tests_blocks

@dcoudert
Copy link
Contributor

comment:4

Should I also fix cases where we have some text. :: instead of some text:: ? it can also be done in another ticket.


New commits:

4ab1180trac #31461: formatting of TESTS blocks

@DaveWitteMorris
Copy link
Member

Reviewer: Dave Morris

@DaveWitteMorris
Copy link
Member

comment:5

Thanks for fixing this. You can set to positive review on my behalf when the patchbot is green.

I don't think some text. :: should be changed unless there is a problem in a particular case (or there is a sage style convention about this). There is nothing wrong with using this style as far as sphinx is concerned: this sphinx web page says "The handling of the :: marker is smart: ... If it is preceded by whitespace, the marker is removed." So some text. :: will show up as a paragraph that ends with a period, instead of a colon, and that seems ok to me.

@vbraun
Copy link
Member

vbraun commented Mar 18, 2021

Changed branch from public/graphs/31461_tests_blocks to 4ab1180

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

5 participants