Skip to content

relax some doctests to better match non-requirement of ordering of Dict and Set#57693

Merged
oscardssmith merged 4 commits intoJuliaLang:masterfrom
adienes:relax_doctests
Mar 25, 2025
Merged

relax some doctests to better match non-requirement of ordering of Dict and Set#57693
oscardssmith merged 4 commits intoJuliaLang:masterfrom
adienes:relax_doctests

Conversation

@adienes
Copy link
Copy Markdown
Member

@adienes adienes commented Mar 9, 2025

discovered during failure of doctests in #57509 but is an independent change

@adienes adienes added docs This change adds or pertains to documentation test This change adds or pertains to unit tests labels Mar 9, 2025
@adienes
Copy link
Copy Markdown
Member Author

adienes commented Mar 13, 2025

look ok?

@adienes
Copy link
Copy Markdown
Member Author

adienes commented Mar 16, 2025

@jakobnissen I tried to narrow the filters a bit --- concretely that meant changing a few \s* to \s+, some \S to \d, and adding end-of-line marks $ where appropriate. I don't know if I was able to address all comments, but hopefully it's closer now

I do think though as a general rule of thumb I would design doctests to be looser than optimal rather than stricter, since they will never be able to be as comprehensive / accurate as dedicated unit tests.

@jakobnissen
Copy link
Copy Markdown
Member

That's fair. You're right, doctests are mostly meant to ensure the code runs (although having them work as actual tests is of course nice, where possible)

@adienes
Copy link
Copy Markdown
Member Author

adienes commented Mar 18, 2025

if this looks ok, a merge would make CI more friendly on #57509

@adienes
Copy link
Copy Markdown
Member Author

adienes commented Mar 25, 2025

bump

@oscardssmith oscardssmith merged commit 123a556 into JuliaLang:master Mar 25, 2025
7 checks passed
@adienes adienes deleted the relax_doctests branch April 9, 2025 18:58
oscardssmith pushed a commit that referenced this pull request Apr 28, 2025
… ordering of Dict and Set" (#58053)

I missed a few of these in the initial PR here
#57693

hopefully there aren't any more...
LebedevRI pushed a commit to LebedevRI/julia that referenced this pull request May 2, 2025
… ordering of Dict and Set" (JuliaLang#58053)

I missed a few of these in the initial PR here
JuliaLang#57693

hopefully there aren't any more...
charleskawczynski pushed a commit to charleskawczynski/julia that referenced this pull request May 12, 2025
… ordering of Dict and Set" (JuliaLang#58053)

I missed a few of these in the initial PR here
JuliaLang#57693

hopefully there aren't any more...
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

docs This change adds or pertains to documentation test This change adds or pertains to unit tests

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants