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

Color and PyfaceColor Documentation #710

Merged
merged 1 commit into from
Oct 6, 2020
Merged

Conversation

corranwebster
Copy link
Contributor

Add documentation for the Color class and PyfaceColor trait.

@codecov-commenter
Copy link

codecov-commenter commented Sep 30, 2020

Codecov Report

Merging #710 into master will increase coverage by 0.76%.
The diff coverage is 93.33%.

Impacted file tree graph

@@            Coverage Diff             @@
##           master     #710      +/-   ##
==========================================
+ Coverage   39.76%   40.53%   +0.76%     
==========================================
  Files         493      502       +9     
  Lines       27259    27614     +355     
  Branches     4140     4185      +45     
==========================================
+ Hits        10840    11193     +353     
- Misses      15944    15950       +6     
+ Partials      475      471       -4     
Impacted Files Coverage Δ
pyface/ui/qt4/data_view/data_view_item_model.py 49.30% <38.46%> (-0.70%) ⬇️
pyface/ui/wx/data_view/data_wrapper.py 86.36% <86.36%> (ø)
pyface/data_view/i_data_wrapper.py 88.46% <88.46%> (ø)
...face/data_view/data_models/row_table_data_model.py 91.25% <91.25%> (ø)
pyface/ui_traits.py 86.11% <93.93%> (+2.32%) ⬆️
pyface/data_view/value_types/color_value.py 95.45% <95.45%> (ø)
pyface/color.py 100.00% <100.00%> (ø)
pyface/data_view/abstract_value_type.py 97.72% <100.00%> (+0.29%) ⬆️
pyface/data_view/data_models/data_accessors.py 100.00% <100.00%> (ø)
pyface/data_view/data_wrapper.py 100.00% <100.00%> (ø)
... and 22 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 c98015c...753a3bd. Read the comment docs.

Copy link
Contributor

@rahulporuri rahulporuri left a comment

Choose a reason for hiding this comment

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

LGTM with one small correction. Haven't tested the built docs though.

the color to use in part of the UI. Each toolkit usually has its own way of
representing colors, and so the ability to specify a color in a
toolkit-independent way that can be converted to a toolkit-specific
representation is important. This is particularly so when you want to allow
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
representation is important. This is particularly so when you want to allow
representation is important. This is particularly important when you want to allow

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I think I prefer the "so" - it references pack to the "important" in the previous sentence without repeating the word.

@corranwebster corranwebster merged commit 61ac7e1 into master Oct 6, 2020
@corranwebster corranwebster deleted the doc/color-trait branch October 6, 2020 09:03
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.

3 participants