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

Add REPL tricks to documentation #66

Closed
ranocha opened this issue Aug 18, 2020 · 2 comments
Closed

Add REPL tricks to documentation #66

ranocha opened this issue Aug 18, 2020 · 2 comments
Labels
documentation Improvements or additions to documentation

Comments

@ranocha
Copy link
Member

ranocha commented Aug 18, 2020

In GitLab by @sloede on May 28, 2020, 08:01

@ranocha has already pointed out a lot of useful tricks for how to use the REPL more effectively and efficiently, such as the benefit of methodswith(). I think it would be helpful to include a section named something like REPL Usage in the docs, where we can collect these kinds of things.

I know this is not strictly documenting "Trixi, the code", but if we consider it more to be "Trixi, the project", I think it makes a lot of sense.

@ranocha ranocha added the documentation Improvements or additions to documentation label Aug 18, 2020
@ranocha
Copy link
Member Author

ranocha commented Aug 18, 2020

In GitLab by @ranocha on May 28, 2020, 08:05

I like to use

  • the REPL help mode entered with ?
  • @which and/or @edit for function calls
  • function_name(<tab><tab> to get a list of methods and possible arguments
  • methodswith

@ranocha
Copy link
Member Author

ranocha commented Aug 18, 2020

In GitLab by @sloede on May 28, 2020, 08:08

mentioned in merge request !57

@ranocha ranocha mentioned this issue Nov 9, 2020
@ranocha ranocha closed this as completed Nov 9, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

1 participant