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鈥檒l occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: Moved need help section after code snippet #959

Merged
merged 1 commit into from
Jun 23, 2022
Merged

Conversation

frgfm
Copy link
Collaborator

@frgfm frgfm commented Jun 23, 2022

Following up on #946, this PR introduces the following modifications:

  • moved the need help section after the code snippet (otherwise the code example is starting to make less sense 馃槄)
  • moved the image to a release attachment

Any feedback is welcome!

@frgfm frgfm added topic: documentation Improvements or additions to documentation type: enhancement Improvement labels Jun 23, 2022
@frgfm frgfm added this to the 0.6.0 milestone Jun 23, 2022
@frgfm frgfm requested a review from fharper June 23, 2022 16:00
@frgfm frgfm self-assigned this Jun 23, 2022
@codecov
Copy link

codecov bot commented Jun 23, 2022

Codecov Report

Merging #959 (223acea) into main (c681273) will not change coverage.
The diff coverage is n/a.

@@           Coverage Diff           @@
##             main     #959   +/-   ##
=======================================
  Coverage   94.83%   94.83%           
=======================================
  Files         134      134           
  Lines        5539     5539           
=======================================
  Hits         5253     5253           
  Misses        286      286           
Flag Coverage 螖
unittests 94.83% <酶> (酶)

Flags with carried forward coverage won't be shown. Click here to find out more.

Impacted Files Coverage 螖
doctr/transforms/modules/base.py 94.59% <0.00%> (酶)

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 c681273...223acea. Read the comment docs.

Copy link
Contributor

@felixdittrich92 felixdittrich92 left a comment

Choose a reason for hiding this comment

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

Much better 馃槄 馃憤

@felixdittrich92 felixdittrich92 merged commit a2626a1 into main Jun 23, 2022
@frgfm frgfm deleted the need-help branch June 25, 2022 09:53
@frgfm frgfm mentioned this pull request Jun 28, 2022
85 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
topic: documentation Improvements or additions to documentation type: enhancement Improvement
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants