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

Tutorial in the docs seems outdated #30

Closed
jlchan opened this issue Jul 18, 2023 · 3 comments · Fixed by #43
Closed

Tutorial in the docs seems outdated #30

jlchan opened this issue Jul 18, 2023 · 3 comments · Fixed by #43
Labels
documentation Improvements or additions to documentation

Comments

@jlchan
Copy link
Contributor

jlchan commented Jul 18, 2023

https://trixi-framework.github.io/HOHQMesh.jl/dev/guided-tour/#Build-a-mesh-from-scratch

In particular, saveProject does not run automatically when generate_mesh is called, and saveProject(p, ::String) doesn't seem to work (only a saveProject(p) signature appears to be exported). This is with v0.2.1 on @MarkLopat's Windows machine.

@ranocha ranocha added the documentation Improvements or additions to documentation label Jul 19, 2023
@DavidAKopriva
Copy link
Collaborator

There is no saveProject(p, ::String) method, so that should be fixed. However, saveProject is called when generate_mesh is invoked at L31. (If it wasn't, then HOHQMesh.f90 wouldn't have a control file to generate a mesh.) So I am asking for more details here as to why you don't think it is.

@jlchan
Copy link
Contributor Author

jlchan commented Jul 26, 2023

When we tried it again yesterday, @MarkLopat was copying and pasting the code into the REPL. For some reason, the last two commands were getting transformed into strings and not being run. I don't think this issue is related to HOHQMesh or HOHQMesh.jl, though.

@andrewwinters5000
Copy link
Member

I will update the docs in a forthcoming PR to address this issue. I found that the "Guided tour" (and possibly other places) indicates the wrong call signature for the saveProject function as shown in this screenshot from the current docs (the last part of the "Guided tour" page):

Screenshot 2024-01-05 at 07 20 38

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

Successfully merging a pull request may close this issue.

4 participants