Skip to content

Conversation

@Iximiel
Copy link
Member

@Iximiel Iximiel commented Oct 9, 2025

If this passes the CI it will be the key to remove all the clutter of temporary files from the search in the new manual

Expect a new pr with a formatter in some time, because the files are an hell to work with (and the new diffs will be more human to understand)

@Iximiel Iximiel force-pushed the testplumedheaderinprocessmd branch from 31e5733 to e80753f Compare October 9, 2025 06:47
@gtribello
Copy link
Member

Hi @Iximiel

I will accept this, but could you please clarify what you are trying to do? Consider what you wrote here from my point of view:

"Expect a new PR with a formatter in some time, because the files are an hell to work with (and the new diffs will be more human to understand)"

I have no idea what this means. You need to explain:

  1. Why are the files difficult to work with?
  2. The changes you made, and why you think that will make it easier for others to work with the files?

When you send messages like the one above, what others read is: "you have no idea what you are doing. It is a good job I am here to fix the messes that you are making." It doesn't matter whether you mean that or not; it is how what you have written comes across.

@gtribello gtribello merged commit 801ab0f into plumed:main Oct 9, 2025
7 checks passed
@Iximiel
Copy link
Member Author

Iximiel commented Oct 9, 2025

Sorry, working on the train makes me scrungy

Passing the options of called functions as a dictionary makes easier to change them when in you will want to add some extra option to test_plumed, or to pass them, so you'll need to change less functions

I have a modified build_manual.py that implements this

For example with these modifications if you search for ACCUMULATE in the first search bar that you see on the site you'll get the ACCUMULATE action and not the stdout and stderr of the examples. There is less friction like this.

from this:
immagine

to this:
immagine

The part about formatting has the same idea behind using astyle in plumed: the diff will be clearer and the file are less horizontal scrollbar noise, the tabulation will be always the same amount of spaces
And there is less brainwork in manually adjusting the files after a modification, because ruff will do it for you

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants