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

Improve warning messages during including (refs: #4818) #4821

Merged
merged 1 commit into from Apr 22, 2018

Conversation

tk0miya
Copy link
Member

@tk0miya tk0miya commented Apr 8, 2018

Feature or Bugfix

  • Feature

Purpose

  • To be clarify the warning, this add includee filename to warnings

Before:

error.txt:1: WARNING: Include file '/Users/tkomiya/work/tmp/doc/notfound' not found or reading it failed

After:

error.txt <included from /Users/tkomiya/work/tmp/doc/index.rst>:1: WARNING: Include file '/Users/tkomiya/work/tmp/doc/notfound' not found or reading it failed

refs: #4818

@tk0miya tk0miya added the markup label Apr 8, 2018
@tk0miya tk0miya added this to the 1.8 milestone Apr 8, 2018
@tk0miya tk0miya force-pushed the 4818_warnings_on_including branch from 73a49df to 8f5a7fe Compare April 8, 2018 11:24
@codecov
Copy link

codecov bot commented Apr 8, 2018

Codecov Report

Merging #4821 into master will decrease coverage by <.01%.
The diff coverage is 100%.

Impacted file tree graph

@@            Coverage Diff             @@
##           master    #4821      +/-   ##
==========================================
- Coverage   82.24%   82.23%   -0.01%     
==========================================
  Files         291      286       -5     
  Lines       38274    37965     -309     
  Branches     5921     5867      -54     
==========================================
- Hits        31477    31222     -255     
+ Misses       5480     5435      -45     
+ Partials     1317     1308       -9
Impacted Files Coverage Δ
sphinx/directives/other.py 91.17% <100%> (+0.36%) ⬆️
sphinx/quickstart.py
sphinx/__init__.py
sphinx/apidoc.py
sphinx/errors.py
sphinx/search/__init__.py
sphinx/builders/html.py 82.48% <0%> (+0.11%) ⬆️

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 bed7643...a4dbb6e. Read the comment docs.

@tk0miya tk0miya merged commit 0db15c9 into sphinx-doc:master Apr 22, 2018
@tk0miya tk0miya deleted the 4818_warnings_on_including branch April 22, 2018 12:34
@github-actions github-actions bot locked as resolved and limited conversation to collaborators Sep 2, 2021
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants