Skip to content

Active fail_on_warning RTD#614

Merged
thepabloaguilar merged 4 commits intomasterfrom
issue-568
Sep 19, 2020
Merged

Active fail_on_warning RTD#614
thepabloaguilar merged 4 commits intomasterfrom
issue-568

Conversation

@thepabloaguilar
Copy link
Copy Markdown
Member

@thepabloaguilar thepabloaguilar commented Sep 18, 2020

I've fixed all documentation warnings and created .readthedocs.yml to active the fail_on_warning flag!!
But we have a problem here, to fix the warnings about ForwardReference I've added the imports from __future__ import annotations, unfortunately the hypothesis' tests are failing. I think it's related to this issue: HypothesisWorks/hypothesis#2565

Checklist

  • I have double checked that there are no unrelated changes in this pull request (old patches, accidental config files, etc)

Related issues

Closes #568

We got some highlight errors when `pygments` tried to parse the code
So, we need to use the directive `:force:` and force our code to be highlighted
doc8 is falling because it can't figure out what's the `:force:` directive
@sobolevn
Copy link
Copy Markdown
Member

😭

Copy link
Copy Markdown
Member

@sobolevn sobolevn left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks a lot for your work!

I don't know how to fix Hypothesis types right now.
Because the easiest way is to contribute to Hypothesis the fix we need.
But, the fix we need is non-trivial. Because it should work for all generics, not just Type, etc.
And I don't have any solution to offer right now.
So, if you have any ideas how to solve the type resolutions, please, share them! 👍

We need to add this import for now because `sphinx` can't figure out
how to make the forward reference. To avoid warnings about this problem
we have to import in all files that uses forward references.
@codecov
Copy link
Copy Markdown

codecov bot commented Sep 19, 2020

Codecov Report

Merging #614 into master will not change coverage.
The diff coverage is 100.00%.

Impacted file tree graph

@@            Coverage Diff            @@
##            master      #614   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files           74        74           
  Lines         1733      1771   +38     
  Branches       123       123           
=========================================
+ Hits          1733      1771   +38     
Impacted Files Coverage Δ
returns/primitives/types.py 100.00% <ø> (ø)
returns/context/requires_context.py 100.00% <100.00%> (ø)
returns/context/requires_context_future_result.py 100.00% <100.00%> (ø)
returns/context/requires_context_ioresult.py 100.00% <100.00%> (ø)
returns/context/requires_context_result.py 100.00% <100.00%> (ø)
returns/interfaces/specific/future.py 100.00% <100.00%> (ø)
returns/interfaces/specific/future_result.py 100.00% <100.00%> (ø)
returns/interfaces/specific/io.py 100.00% <100.00%> (ø)
returns/interfaces/specific/ioresult.py 100.00% <100.00%> (ø)
returns/interfaces/specific/reader.py 100.00% <100.00%> (ø)
... and 12 more

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 73e1474...090436b. Read the comment docs.

@thepabloaguilar thepabloaguilar merged commit 2c18487 into master Sep 19, 2020
@thepabloaguilar thepabloaguilar deleted the issue-568 branch September 19, 2020 17:02
@thepabloaguilar thepabloaguilar mentioned this pull request Sep 19, 2020
1 task
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Development

Successfully merging this pull request may close these issues.

Active fail_on_warning RTD

2 participants