Address warnings when parsing demo docstrings #1378
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
modified: traitsui/examples/demo/Advanced/Auto_update_TabularEditor_demo.py modified: traitsui/examples/demo/Advanced/Dynamic_EnumEditor_demo.py modified: traitsui/examples/demo/Advanced/Dynamic_range_trait_and_editor.py modified: traitsui/examples/demo/Advanced/Popup_Dialog_demo.py modified: traitsui/examples/demo/Advanced/Tabular_editor_demo.py modified: traitsui/examples/demo/Standard_Editors/File_Dialog/File_Open_with_ImageInfo_Extension.py modified: traitsui/examples/demo/Standard_Editors/File_Dialog/File_Open_with_TextInfo_Extension.py modified: traitsui/examples/demo/Standard_Editors/SetEditor_demo.py modified: traitsui/examples/demo/Standard_Editors/TreeEditor_demo.py
rahulporuri
commented
Oct 16, 2020
Comment on lines
+26
to
+28
| - The key point of the demo is the use of the 'name' trait in the EnumEditor | ||
| definition, which links the list of available entrees from the | ||
| KitchenCapabilities object to the OrderMenu object's entree EnumEditor. |
There was a problem hiding this comment.
these weren't raising warnings but they did have an awkward indentation.
Comment on lines
+40
to
+42
| - The dynamic range trait is the 'temperature' trait in the Guest class. It | ||
| depends upon traits defined both in the Guest instance as well as in the | ||
| containing Hotel object. |
There was a problem hiding this comment.
these were also not raising warnings but like with the other comment, these had an awkward indentation.
| @@ -55,39 +55,39 @@ | |||
| - If the demo is running under QT, you can move rows by clicking and dragging. | |||
|
|
|||
| Hopefully, this simple example conveys some of the power and flexibility that | |||
| the :py:class:`TabularAdapter` class provides you. But, just in case it | |||
There was a problem hiding this comment.
The :py:class: (and other :py:*: tags) don't work in the standalone etsdemo application because the code has no access to documentation.
Comment on lines
+10
to
+12
| - Company | ||
| - Department | ||
| - Employee |
There was a problem hiding this comment.
without proper indentation, this was raising warnings, which is fixed by adding tabs for indentation.
31 tasks
aaronayres35
approved these changes
Oct 16, 2020
rahulporuri
added
the
need backport to maint/*
kitchoi
pushed a commit
that referenced
this pull request
Oct 19, 2020
modified: traitsui/examples/demo/Advanced/Auto_update_TabularEditor_demo.py modified: traitsui/examples/demo/Advanced/Dynamic_EnumEditor_demo.py modified: traitsui/examples/demo/Advanced/Dynamic_range_trait_and_editor.py modified: traitsui/examples/demo/Advanced/Popup_Dialog_demo.py modified: traitsui/examples/demo/Advanced/Tabular_editor_demo.py modified: traitsui/examples/demo/Standard_Editors/File_Dialog/File_Open_with_ImageInfo_Extension.py modified: traitsui/examples/demo/Standard_Editors/File_Dialog/File_Open_with_TextInfo_Extension.py modified: traitsui/examples/demo/Standard_Editors/SetEditor_demo.py modified: traitsui/examples/demo/Standard_Editors/TreeEditor_demo.py (cherry picked from commit f9dfbdc)
kitchoi
added a commit
that referenced
this pull request
Oct 19, 2020
* Add IsEnabled to the tester api docstring (#1367) (cherry picked from commit e454a7b) * Refresh developer command for generating API documentation (#1368) * Update docs command to autogenerate API documentation source * Remove source which will now be generated automatically * Update API index page * Ignore the generated source directory in .gitignore (cherry picked from commit 79b9e3c) * Allow docs command to be run on Windows (#1369) (cherry picked from commit 8265c31) * Add a test for traitsui.testing.api (#1370) * adding a test_api file for traitsui.testing.api * flake8 * adding comment about ordering of imports in api matching docstring * not importing from api in internal non-test code * typo (cherry picked from commit 382fa8e) * have test_ListEditor_demo.py use traitsui.testing.api module for imports (#1371) (cherry picked from commit 7d9d1e1) * Skip load_tests in API documentation (#1376) (cherry picked from commit 175c0a1) * Don't import from traitsui.testing.api in internal editor implementations (#1377) * not importing from API in internal editor implementations * alphabetical order imports * suggested change (typo) (cherry picked from commit cfa7781) * FIX : Address SyntaxErrors when parsing demo docs (#1378) modified: traitsui/examples/demo/Advanced/Auto_update_TabularEditor_demo.py modified: traitsui/examples/demo/Advanced/Dynamic_EnumEditor_demo.py modified: traitsui/examples/demo/Advanced/Dynamic_range_trait_and_editor.py modified: traitsui/examples/demo/Advanced/Popup_Dialog_demo.py modified: traitsui/examples/demo/Advanced/Tabular_editor_demo.py modified: traitsui/examples/demo/Standard_Editors/File_Dialog/File_Open_with_ImageInfo_Extension.py modified: traitsui/examples/demo/Standard_Editors/File_Dialog/File_Open_with_TextInfo_Extension.py modified: traitsui/examples/demo/Standard_Editors/SetEditor_demo.py modified: traitsui/examples/demo/Standard_Editors/TreeEditor_demo.py (cherry picked from commit f9dfbdc) * Update Changelog * Update deprecation warnings for removing traitsui.image (#1384) * Update deprecation warnings for removing traitsui.image * Update message to mention previous plan (cherry picked from commit 04a7b04) * Add 'Future removals' section in the changelog * Sort last names alphabetically Co-authored-by: aaronayres35 <36972686+aaronayres35@users.noreply.github.com> Co-authored-by: Poruri Sai Rahul <rporuri@enthought.com>
kitchoi
removed
the
need backport to maint/*
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
fixes #1126
This PR fixes issues that arise when parsing the demo module docstrings - displayed in the etsdemo application.