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

Address a few sphinx warnings #846

Merged
merged 2 commits into from
Dec 16, 2020
Merged

Address a few sphinx warnings #846

merged 2 commits into from
Dec 16, 2020

Conversation

rahulporuri
Copy link
Contributor

Not sure if this is the right fix but this is a fix. This PR addresses the following sphinx warnings :

pyface\tasks\tasks_application.py:docstring of pyface.tasks.tasks_application.TaskFactory.factory:3: WARNING: Inline strong start-string without end-string.
pyface\timer\do_later.py:docstring of pyface.timer.do_later.do_later:5: WARNING: Inline strong start-string without end-string.
pyface\timer\do_later.py:docstring of pyface.timer.do_later.do_later:6: WARNING: Inline strong start-string without end-string.
pyface\timer\do_later.py:docstring of pyface.timer.do_later.do_after:7: WARNING: Inline strong start-string without end-string.
pyface\timer\do_later.py:docstring of pyface.timer.do_later.do_after:8: WARNING: Inline strong start-string without end-string.

Interpreting the "Inline strong start-string" as "**", the fix I employed was to simply escape the characters i.e. "\**"

Not sure if this is the right fix but this is a fix

	modified:   pyface/tasks/tasks_application.py
	modified:   pyface/timer/do_later.py
@codecov-io
Copy link

codecov-io commented Dec 10, 2020

Codecov Report

Merging #846 (3634f94) into master (92ab736) will increase coverage by 0.13%.
The diff coverage is 100.00%.

Impacted file tree graph

@@            Coverage Diff             @@
##           master     #846      +/-   ##
==========================================
+ Coverage   41.15%   41.29%   +0.13%     
==========================================
  Files         522      522              
  Lines       28110    28123      +13     
  Branches     4251     4253       +2     
==========================================
+ Hits        11568    11612      +44     
+ Misses      16037    16014      -23     
+ Partials      505      497       -8     
Impacted Files Coverage Δ
pyface/action/action_manager.py 83.92% <ø> (ø)
pyface/tasks/tasks_application.py 56.94% <ø> (ø)
pyface/timer/do_later.py 100.00% <ø> (ø)
pyface/resource/resource_manager.py 59.32% <100.00%> (+7.89%) ⬆️
pyface/ui/qt4/console/console_widget.py 28.86% <0.00%> (+0.31%) ⬆️
pyface/ui/qt4/code_editor/code_widget.py 43.55% <0.00%> (+0.84%) ⬆️
pyface/wx/python_stc.py 10.36% <0.00%> (+1.21%) ⬆️
pyface/ui/qt4/tasks/task_window_backend.py 60.52% <0.00%> (+1.31%) ⬆️
pyface/ui/qt4/util/gui_test_assistant.py 80.53% <0.00%> (+2.65%) ⬆️
... and 5 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 3ea7832...3634f94. Read the comment docs.

Copy link
Contributor

@kitchoi kitchoi left a comment

Choose a reason for hiding this comment

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

Confirmed the warnings in timer package are gone. The rendered doc still looks a bit odd but this PR has not made it worse.

pyface/timer/do_later.py Outdated Show resolved Hide resolved
Co-authored-by: Kit Choi <kitchoi@users.noreply.github.com>
@rahulporuri rahulporuri merged commit 4a991af into master Dec 16, 2020
@rahulporuri rahulporuri deleted the fix/some-sphinx-warnings branch December 16, 2020 09:57
@rahulporuri rahulporuri moved this from Done to Sprint 6 : Dec 14 2020 - Jan 2 2021 in Enthought OSS Q4 2020 Jan 5, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
No open projects
Enthought OSS Q4 2020
Sprint 6 : Dec 14 2020 - Jan 2 2021
Development

Successfully merging this pull request may close these issues.

None yet

3 participants