Thanks to visit codestin.com
Credit goes to github.com

Skip to content

update documentation after #18966 #22288

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.

Sign up for GitHub

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

Jump to bottom
Merged
merged 3 commits into from
Jan 27, 2022
Merged

update documentation after #18966 #22288

merged 3 commits into from
Jan 27, 2022

Conversation

impact27
Copy link
Contributor

PR Summary

PR Checklist

Tests and Styling

  • Has pytest style unit tests (and pytest passes).
  • Is Flake 8 compliant (install flake8-docstrings and run flake8 --docstring-convention=all).

Documentation

  • New features are documented, with examples if plot related.
  • New features have an entry in doc/users/next_whats_new/ (follow instructions in README.rst there).
  • API changes documented in doc/api/next_api_changes/ (follow instructions in README.rst there).
  • Documentation is sphinx and numpydoc compliant (the docs should build without error).

@tacaswell tacaswell modified the milestones: v3.6.0, v3.5.2 Jan 22, 2022
@tacaswell
Copy link
Member

@oscargus mentioned in #22202 (comment) that there is also an example that needs to be fixed?

Would it be better to fix the return or as that impossible with the other changes now?

@impact27
Copy link
Contributor Author

impact27 commented Jan 22, 2022 •
edited
Loading

I don’t think returning something would be good as this is clearly not a synchronous operation. I think the callback is a better solution to get a return value

@impact27
Copy link
Contributor Author

Where is this example?

@tacaswell
Copy link
Member

They are in a if __name__ == "__main__": at the bottom of this file

matplotlib/lib/matplotlib/backends/qt_editor/_formlayout.py

Lines 542 to 585 in fd51e05

if __name__ == "__main__":
def create_datalist_example():
return [('str', 'this is a string'),
('list', [0, '1', '3', '4']),
('list2', ['--', ('none', 'None'), ('--', 'Dashed'),
('-.', 'DashDot'), ('-', 'Solid'),
('steps', 'Steps'), (':', 'Dotted')]),
('float', 1.2),
(None, 'Other:'),
('int', 12),
('font', ('Arial', 10, False, True)),
('color', '#123409'),
('bool', True),
('date', datetime.date(2010, 10, 10)),
('datetime', datetime.datetime(2010, 10, 10)),
]
def create_datagroup_example():
datalist = create_datalist_example()
return ((datalist, "Category 1", "Category 1 comment"),
(datalist, "Category 2", "Category 2 comment"),
(datalist, "Category 3", "Category 3 comment"))
# --------- datalist example
datalist = create_datalist_example()
def apply_test(data):
print("data:", data)
print("result:", fedit(datalist, title="Example",
comment="This is just an <b>example</b>.",
apply=apply_test))
# --------- datagroup example
datagroup = create_datagroup_example()
print("result:", fedit(datagroup, "Global title"))
# --------- datagroup inside a datagroup example
datalist = create_datalist_example()
datagroup = create_datagroup_example()
print("result:", fedit(((datagroup, "Title 1", "Tab 1 comment"),
(datalist, "Title 2", "Tab 2 comment"),
(datalist, "Title 3", "Tab 3 comment")),
"Global title"))

tacaswell
tacaswell approved these changes Jan 26, 2022
View reviewed changes
Copy link
Member

@tacaswell tacaswell left a comment

Choose a reason for hiding this comment

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

Still approve after edits

@tacaswell
Copy link
Member

tacaswell commented Jan 27, 2022 •
edited
Loading

The test failure is test_fork merging over that because we understand it (regression from coverage 6.3) and it is fixed on main and 3.5.x.

@tacaswell tacaswell merged commit 738518a into matplotlib:main Jan 27, 2022
meeseeksmachine pushed a commit to meeseeksmachine/matplotlib that referenced this pull request Jan 27, 2022
@tacaswell @meeseeksmachine
Backport PR matplotlib#22288: update documentation after matplotlib#1…
386326d 
…8966
@meeseeksmachine meeseeksmachine mentioned this pull request Jan 27, 2022
Merged
tacaswell added a commit that referenced this pull request Jan 27, 2022
@tacaswell
Merge pull request #22328 from meeseeksmachine/auto-backport-of-pr-22…
dae7a48 
…288-on-v3.5.x

Backport PR #22288 on branch v3.5.x (update documentation after #18966)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@tacaswell tacaswell tacaswell approved these changes

@timhoffm timhoffm timhoffm approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
v3.5.2
Development

Successfully merging this pull request may close these issues.
3 participants
@impact27 @tacaswell @timhoffm