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

Improvements in readme #95

Open
AdrienTaylor opened this issue Feb 12, 2024 · 1 comment
Open

Improvements in readme #95

AdrienTaylor opened this issue Feb 12, 2024 · 1 comment
Assignees
@bgoujaud
Labels
enhancement New feature or request

Comments

@AdrienTaylor
Copy link
Collaborator

Remarks from @Dralliag

The example from https://pepit.readthedocs.io/en/0.3.2/quickstart.html should include a few additional definitions (allowing to run the example)

  • "fs" is undefined,
  • "L" is undefined.
@AdrienTaylor
Copy link
Collaborator Author

Similarly:

  • add links to the appropriate files in the "quickstart"
  • a few sentences are difficult to parse in the "quickstart"

@AdrienTaylor AdrienTaylor added the enhancement New feature or request label Apr 23, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@bgoujaud bgoujaud

Labels
enhancement New feature or request
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@bgoujaud @AdrienTaylor