Auto synchronize the test problems README.md to wiki page#350
Auto synchronize the test problems README.md to wiki page#350ChunYen-Chen wants to merge 7 commits intogamer-project:mainfrom
README.md to wiki page#350Conversation
|
@ChunYen-Chen Please resolve the conflicts. |
|
hsinhaoHHuang
left a comment
There was a problem hiding this comment.
@ChunYen-Chen
Thanks for this PR. This is quite a huge task!
I have reviewed through all of the test problems. Beside the inline comments, there are two general comments:
-
About the format of tables.
Although it will not affect the rendering of markdown on GitHub, I think it would look better in plain text mode if we could align the table borders and fill in the dashed lines in the grid for the headers.
For example, inexample/test_problem/ELBDM/IsolatedHalo/README.md- Boundary conditions | Parameter name | Value | Note | |--- |--- |--- | | OPT__BC_FLU_* | 1 | periodic | | OPT__BC_POT | 2 | isolated |->
- Boundary conditions | Parameter name | Value | Note | |----------------|-------|----------| | OPT__BC_FLU_* | 1 | periodic | | OPT__BC_POT | 2 | isolated | -
About the version control.
It seems that for most ELBDM test problems (e.g., DiskHeating, GaussianWavePacket, IsolatedHalo, LSS_Hybrid) (except forHaloMerger), the git history is lost after file renaming. (HYDRO test problems don't have this issue).
I guess it is because both the filename and contents changed a lot in the same commit and git lost track of them.
I guess we need to separate the file renaming and modifying contents into two commits to avoid this issue (like you did for HYDRO).- On local, with
git log --follow, there's no previous commits.$ git log --follow --oneline example/test_problem/ELBDM/DiskHeating/README.md f5cd21d Update wiki c42c98f Update wiki d005b60 Update wiki dce7730 Typo 4a4a138 Rename the title 9dcde1d Update README.md 7108133 Update README.md 12e84db Add ELBDM test problems - On GitHub commits, it shows the wrong history.

- On local, with
| > [!CAUTION] | ||
| > This setup requires further verification |
There was a problem hiding this comment.
I am not sure, but I guess this refers to the above STABLE setup. If so, it would be better to align it with the same indentation.
| > [!CAUTION] | |
| > This setup requires further verification | |
| > [!CAUTION] | |
| > This setup requires further verification |
There was a problem hiding this comment.
The alert does not support indention. (https://github.com/orgs/community/discussions/16925#discussioncomment-12029106)
6e75901 to
ec57f15
Compare
Conflicts: example/test_problem/ELBDM/DiskHeating/README example/test_problem/ELBDM/GaussianWavePacket/README example/test_problem/ELBDM/HaloMerger/README example/test_problem/ELBDM/IsolatedHalo/README example/test_problem/ELBDM/PlaneWave/README example/test_problem/Hydro/Zeldovich/README
|
@ChunYen-Chen @hsinhaoHHuang Please let me know when this PR is ready to be merged. Thanks! |
Similar to PR #337, this PR includes the auto-update wiki workflow
Update test problem wiki page.Setup
Please ensure that the secret
MY_EMAILandTOKEN_FOR_WIKIare set in your repository.How it works
This workflow is triggered by any changes to the following files:
example/test_problem/*/*/README.mdtool/wiki/sync_test_problem_pages.pyOthers
All the
READMEof test problems are updated to the markdown style.