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

More docs for main_window flag #118

Merged
merged 19 commits into from
Jan 22, 2021
Merged

More docs for main_window flag #118

merged 19 commits into from
Jan 22, 2021

Conversation

HagaiHargil
Copy link
Contributor

@HagaiHargil HagaiHargil commented Jan 22, 2021

I've added a documentation entry for the main window feature as well as an example script.

I also introduced a very small modification for the code itself - the tooltip parser now removes backticks from the parameters' descriptions.

I wasn't sure whether you want it based on current master or on #110, so I went with the latter. It also simplifies that small fix I just described, but I can obviously do whatever you like here.

@codecov
Copy link

codecov bot commented Jan 22, 2021

Codecov Report

Merging #118 (8db1ca1) into master (9e868da) will increase coverage by 0.00%.
The diff coverage is 100.00%.

Impacted file tree graph

@@           Coverage Diff           @@
##           master     #118   +/-   ##
=======================================
  Coverage   90.24%   90.25%           
=======================================
  Files          25       25           
  Lines        2420     2421    +1     
=======================================
+ Hits         2184     2185    +1     
  Misses        236      236           
Impacted Files Coverage Δ
magicgui/widgets/_function_gui.py 95.27% <100.00%> (+0.03%) ⬆️

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 9e868da...8db1ca1. Read the comment docs.

Copy link
Member

@tlambert03 tlambert03 left a comment

Choose a reason for hiding this comment

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

This is awesome @HagaiHargil, thank you so much!

I've merged the mainwindow PR, so can you merge master back into this PR and push again?

I've left a few nitpicky requests. Much appreciated!

docs/usage/main_window.md Outdated Show resolved Hide resolved
docs/usage/main_window.md Outdated Show resolved Hide resolved
docs/usage/main_window.md Show resolved Hide resolved
docs/usage/main_window.md Outdated Show resolved Hide resolved
docs/usage/main_window.md Outdated Show resolved Hide resolved
docs/usage/main_window.md Outdated Show resolved Hide resolved


class HotdogOptions(Enum):
"""All hotdog possibilities"""
Copy link
Member

Choose a reason for hiding this comment

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

😂

@tlambert03
Copy link
Member

oh one more thing... can you add the following line to docs/_toc.yml, right after "direct_api"?

    - file: usage/main_window

Copy link
Member

@tlambert03 tlambert03 left a comment

Choose a reason for hiding this comment

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

fantastic. Thanks again!

@tlambert03 tlambert03 merged commit 16c9d00 into pyapp-kit:master Jan 22, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants