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.

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

Fix broken code in "how to" section of online guide #167

Merged
merged 1 commit into from
Dec 16, 2021
Merged

Fix broken code in "how to" section of online guide #167

merged 1 commit into from
Dec 16, 2021

Conversation

nhuet
Copy link
Contributor

@nhuet nhuet commented Dec 16, 2021

  • The solve_with was called on a solver factory instead of a solver instance -> this is corrected
  • The comment said that LazyAstar was selected but it was not true anymore because other compatible solvers appears before in the list -> explicit choice of solver
  • The rollout is not well displayed if code copied/pasted in a notebook -> add a tip to solve this + link to tutorial notebooks
  • Add the _cleanup step required for some solvers
  • Show how to use the with block to automatically close solvers properly in a tip -> should fix Update documentation guide with new way for solving #111

galleon
galleon suggested changes Dec 16, 2021
View reviewed changes
docs/guide/README.md Outdated
```

### Compute a solution

Here is how to solve `MyDomain` with `MySolver`:
Here is how to solve `MyDomain` with `mySolver`:
Copy link
Contributor

Choose a reason for hiding this comment

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

mySolver or mysolver ;-)

@nhuet
Fix broken code in "how to" section of online guide
b9bea7c 
- The `solve_with was called on a solver factory instead of a solver
instance` -> this is corrected
- The comment said that LazyAstar was selected but it was not true
  anymore because other compatible solvers appears before in the list
  -> explicit choice of solver
- The rollout is not well displayed if code copied/pasted in a notebook
  -> add a tip to solve this + link to tutorial notebooks
- Add the _cleanup step required for some solvers
- Show how to use the `with` block to automatically close solvers
  properly in a tip -> should fix airbus#111
@nhuet nhuet force-pushed the nh/fix_broken_howto branch from c110366 to b9bea7c Compare December 16, 2021 15:44
galleon
galleon approved these changes Dec 16, 2021
View reviewed changes
Copy link
Contributor

@galleon galleon left a comment

Choose a reason for hiding this comment

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

Looks good to me

@galleon galleon merged commit 8bbf295 into airbus:master Dec 16, 2021
@nhuet nhuet deleted the nh/fix_broken_howto branch December 17, 2021 08:44
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@dbarbier dbarbier dbarbier approved these changes

@galleon galleon galleon approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Update documentation guide with new way for solving
3 participants
@nhuet @dbarbier @galleon