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

Additional documentation for the DataView #763

Merged
merged 6 commits into from
Oct 16, 2020

Conversation

corranwebster
Copy link
Contributor

This includes:

  • drag and drop documentation
  • more info on value type data channels
  • information on DataViewGetError

Fixes #722

@codecov-io
Copy link

codecov-io commented Oct 15, 2020

Codecov Report

Merging #763 into master will increase coverage by 0.57%.
The diff coverage is 93.20%.

Impacted file tree graph

@@            Coverage Diff             @@
##           master     #763      +/-   ##
==========================================
+ Coverage   40.31%   40.89%   +0.57%     
==========================================
  Files         502      508       +6     
  Lines       27652    27832     +180     
  Branches     4193     4217      +24     
==========================================
+ Hits        11148    11381     +233     
+ Misses      16010    15978      -32     
+ Partials      494      473      -21     
Impacted Files Coverage Δ
pyface/data_view/data_models/api.py 75.00% <75.00%> (-25.00%) ⬇️
pyface/ui/qt4/data_view/data_view_widget.py 77.60% <80.00%> (-2.25%) ⬇️
pyface/ui/qt4/data_view/data_view_item_model.py 55.46% <81.39%> (+6.15%) ⬆️
pyface/data_view/exporters/item_exporter.py 81.81% <81.81%> (ø)
pyface/data_view/abstract_data_exporter.py 100.00% <100.00%> (ø)
pyface/data_view/api.py 100.00% <100.00%> (ø)
pyface/data_view/data_formats.py 100.00% <100.00%> (ø)
pyface/data_view/exporters/api.py 100.00% <100.00%> (ø)
pyface/data_view/exporters/row_exporter.py 100.00% <100.00%> (ø)
pyface/data_view/i_data_view_widget.py 95.61% <100.00%> (+0.11%) ⬆️
... and 35 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 9f13097...cdc59a0. Read the comment docs.

@corranwebster corranwebster added the need backport to 7.1 PRs that need to be backported to maint/7.1 label Oct 16, 2020
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.

LGTM. One spelling mistake and two mis-named references.

docs/source/data_view.rst Outdated Show resolved Hide resolved
docs/source/data_view.rst Outdated Show resolved Hide resolved
docs/source/data_view.rst Outdated Show resolved Hide resolved
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.

LGTM

@corranwebster corranwebster merged commit 3acd644 into master Oct 16, 2020
@corranwebster corranwebster deleted the doc/data-view-features branch October 16, 2020 17:00
kitchoi pushed a commit that referenced this pull request Oct 19, 2020
* Add documentation on Drag and Drop.

* Add a note about DataViewGetError.

* More notes on value types.

* Apply suggestions from code review

Co-authored-by: Kit Choi <[email protected]>

* Fix references to exporters.

Co-authored-by: Kit Choi <[email protected]>
(cherry picked from commit 3acd644)
kitchoi added a commit that referenced this pull request Oct 19, 2020
* Add a section to the documentation on the basics of Pyface Widgets. (#739)

(cherry picked from commit 86c9a9c)

* avoid importing ArrayDataModel if numpy is not installed (#749)

* avoid importing ArrayDataModel if numpy is not installed

* replace try except with look-before-you-leap approach

* typo

(cherry picked from commit a68eb28)

* Add api.py to data view packages (#750)

* Add/update api.py modules for data views.

* Use data view api modules in examples.

* Add data view api modules to documentation examples.

* Add some extra imports, change import locations.

* Test API modules in pyface.data_view (#752)

* Add test for pyface.data_view.api

* Add test for pyface.data_view.exporters.api

* Add test for data models API

Make sure the api module is importable even if we don't have NumPy

* Add tests to help developers keeping the list up-to-date

* Fix language in a comment

* Remove mixins from .api.

* Adjust tests.

Co-authored-by: Kit Choi <[email protected]>
(cherry picked from commit e9b7d96)

* Mention the data view API being provisional in the User Manual (#758)

(cherry picked from commit cfb3f8c)

* Set comparison mode to identity for MDataViewWidget.exporters (#759)

(cherry picked from commit d5f5e7f)

* Skip tests packages in API documentation (#761)

(cherry picked from commit 9f13097)

* Skip load_tests in API documentation (#762)

* Skip load_tests in autodoc

* Local flake8

(cherry picked from commit a3ad0f2)

* Additional documentation for the DataView (#763)

* Add documentation on Drag and Drop.

* Add a note about DataViewGetError.

* More notes on value types.

* Apply suggestions from code review

Co-authored-by: Kit Choi <[email protected]>

* Fix references to exporters.

Co-authored-by: Kit Choi <[email protected]>
(cherry picked from commit 3acd644)

* FIX docs click command to work on windows (#764)

* FIX : Docs build on windows

	modified:   etstool.py

* Update etstool.py

Co-authored-by: Kit Choi <[email protected]>

Co-authored-by: Kit Choi <[email protected]>
(cherry picked from commit bac64de)

* CLN : Rename api-docs click command to docs (#766)

Now, traitsui and pyface have the same command name - reducing
unnecessary cognitive overhead.

	modified:   etstool.py

(cherry picked from commit 3a6d349)

* FIX : Correct a docstring (#767)

(cherry picked from commit 95d0474)

* Get ModalDialogTester tests working on pyqt5 (#768)

* FIX : Get ModalDialogTester tests working on pyqt5

The tests were previously being skipped because they failed mysteriously
on pyqt5 - on further investigation, I saw weird errors related to two
of the tests - a missing AttributeError for self.gui

	modified:   pyface/ui/qt4/util/tests/test_modal_dialog_tester.py

* FIX : Reverse order of superclasses

	modified:   pyface/ui/qt4/util/tests/test_modal_dialog_tester.py

(cherry picked from commit 96b8580)

* Address sphinx warnings when building docs (#769)

* FIX : Address sphinx warnings when building docs

* FIX : Revert a confusing change

(i couldnt come up with a worse commit message)

	modified:   pyface/timer/do_later.py

(cherry picked from commit 5b21b49)

* Explicitly extract data from bytearrays rather than rely on wrapper. (#773)

(cherry picked from commit 0d5565f)

* Update changelog

Co-authored-by: Corran Webster <[email protected]>
Co-authored-by: aaronayres35 <[email protected]>
Co-authored-by: Poruri Sai Rahul <[email protected]>
@kitchoi kitchoi removed the need backport to 7.1 PRs that need to be backported to maint/7.1 label Oct 19, 2020
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.

DataView: document that DataValueSetError and DataValueGetError can be ignored
3 participants