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

Fix import in doctest example #14067

Merged
merged 1 commit into from
Aug 9, 2022
Merged

Fix import in doctest example #14067

merged 1 commit into from
Aug 9, 2022

Conversation

robert-s-lee
Copy link
Contributor

@robert-s-lee robert-s-lee commented Aug 6, 2022

What does this PR do?

refactoring was done at some point to move Dict and List to

  • lightning/src/lightning_app/structures/list.py and
  • lightning/src/lightning_app/structures/dict.py

The doctest inside code still reflects the old structure, and cut/paste of examples no longer works.

update the doctest to reflect the new lightning_app.structures

Does your PR introduce any breaking changes? If yes, please list them.

None

Before submitting

  • Was this discussed/approved via a GitHub issue? (not for typos and docs)
  • Did you read the contributor guideline, Pull Request section?
  • Did you make sure your PR does only one thing, instead of bundling different changes together?
  • Did you make sure to update the documentation with your changes? (if necessary)
  • Did you write any new necessary tests? (not for typos and docs)
  • Did you verify new and existing tests pass locally with your changes?
  • Did you list all the breaking changes introduced by this pull request?
  • Did you update the CHANGELOG? (not for typos, docs, test updates, or minor internal changes/refactors)

PR review

Anyone in the community is welcome to review the PR.
Before you start reviewing, make sure you have read the review guidelines. In short, see the following bullet-list:

  • Is this pull request ready for review? (if not, please submit in draft mode)
  • Check that all items from Before submitting are resolved
  • Make sure the title is self-explanatory and the description concisely explains the PR
  • Add labels and milestones (and optionally projects) to the PR so it can be classified

Did you have fun?

Make sure you had fun coding 🙃

@github-actions github-actions bot added the app (removed) Generic label for Lightning App package label Aug 6, 2022
@robert-s-lee robert-s-lee changed the title typo on doctest that has old lightning_app.core.structures and not the new lightning_app.structures typo on doctest that has old lightning_app.core and not the new lightning_app.structures Aug 6, 2022
Copy link
Contributor

@awaelchli awaelchli left a comment

Choose a reason for hiding this comment

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

LGTM
more work needs to be done in the future to fix these imports properly

@mergify mergify bot added the ready PRs ready to be merged label Aug 8, 2022
@mergify mergify bot requested a review from a team August 8, 2022 10:21
@Borda Borda added this to the all:next milestone Aug 8, 2022
@awaelchli awaelchli changed the title typo on doctest that has old lightning_app.core and not the new lightning_app.structures Fix import in doctest example Aug 8, 2022
@awaelchli awaelchli added the docs Documentation related label Aug 8, 2022
@rohitgr7 rohitgr7 merged commit d29a552 into Lightning-AI:master Aug 9, 2022
@carmocca carmocca modified the milestones: all:next, app:0.5.x Aug 9, 2022
@carmocca
Copy link
Contributor

carmocca commented Aug 9, 2022

@Borda I believe this was incorrectly milestoned.

@awaelchli awaelchli modified the milestones: app:0.5.x, app:0.6 Aug 9, 2022
Borda pushed a commit that referenced this pull request Aug 16, 2022
lexierule pushed a commit that referenced this pull request Aug 18, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
app (removed) Generic label for Lightning App package docs Documentation related ready PRs ready to be merged
Projects
No open projects
Status: Done
Development

Successfully merging this pull request may close these issues.

7 participants