Skip to content

Commit

Permalink
Apply suggestions from code review
Browse files Browse the repository at this point in the history
Co-authored-by: Hendrik Ranocha <ranocha@users.noreply.github.com>
  • Loading branch information
andrewwinters5000 and ranocha authored Jan 5, 2024
1 parent 0243705 commit 0a57b60
Show file tree
Hide file tree
Showing 3 changed files with 5 additions and 4 deletions.
3 changes: 2 additions & 1 deletion docs/src/development.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,8 @@ are available for almost any operating system. They also are preinstalled on
virtually all Unix-like systems. However, Vim and Emacs come with their own,
steep learning curve if they have never been used before. Therefore, if in doubt, it
is probably easier to get started with a classic GUI-based text editor (like
VS Code). If you decide to use Vim or Emacs, make sure that you install the
VS Code with the [Julia extension](https://code.visualstudio.com/docs/languages/julia)).
If you decide to use Vim or Emacs, make sure that you install the
corresponding Vim plugin
[julia-vim](https://github.com/JuliaEditorSupport/julia-vim) or Emacs major
mode [julia-emacs](https://github.com/JuliaEditorSupport/julia-emacs).
Expand Down
4 changes: 2 additions & 2 deletions docs/src/guided-tour.md
Original file line number Diff line number Diff line change
Expand Up @@ -134,8 +134,8 @@ To save a control file for HOHQMesh, simply invoke
```
saveProject(proj::Project)
```
where the name of the control file (traditionally with a .control extension) matches the
name of the `proj`.
where the name of the control file (traditionally with a `.control` extension) matches the
name of the project `proj`.
`saveProject` is automatically called when a mesh is generated.

Note, a third example script `interactive_outer_boundary_generic.jl` is identical to that
Expand Down
2 changes: 1 addition & 1 deletion docs/src/interactive-api.md
Original file line number Diff line number Diff line change
Expand Up @@ -112,7 +112,7 @@ type to `LinearAndCrossbarSpring`, and number of iterations = 25.
These are generally good enough for most purposes.
The most likely parameter to change is the number of iterations.
Further details on the smoothing strategy and how it works are available
[here](https://trixi-framework.github.io/HOHQMesh/the-control-input/#the-smoother).
[in the documentation](https://trixi-framework.github.io/HOHQMesh/the-control-input/#the-smoother).

To change the defaults, the smoother parameters can be set/enquired with the functions
```
Expand Down

0 comments on commit 0a57b60

Please sign in to comment.