Issue 1438 - Fixed parameter naming

[lsawade]

Description

writer parameter names all follow word-word-word convention instead of some this way and some in word_word_word fashion.
Also edited the parameter description as well.

Commits

• Fixed parameter naming (0a15d46)
• Merge branch 'devel' into issue-1438 (26dcfcb)

Issue Number

Closes #1438

Checklist

Please make sure to check developer documentation on specfem docs.

• I ran the code through pre-commit to check style
• THE DOCUMENTATION BUILDS WITHOUT WARNINGS/ERRORS
• I have added labels to the PR (see right hand side of the PR page)
• My code passes all the integration tests
• I have added sufficient unittests to test my changes
• I have added/updated documentation for the changes I am proposing
• I have updated CMakeLists to ensure my code builds
• My code builds across all platforms

[Copilot]

Pull request overview

This PR standardizes parameter naming conventions in the wavefield writer configuration by converting from word_word_word (underscore) format to word-word-word (hyphen) format, ensuring consistency across the codebase.

• Updated parameter names in the wavefield writer from underscore to hyphen format
• Updated error messages to reflect the new parameter naming convention
• Added partial documentation for the renamed parameters

Reviewed changes

Copilot reviewed 3 out of 3 changed files in this pull request and generated 3 comments.

File	Description
src/parameter_parser/writer/wavefield.cpp	Renamed four parameters (time-interval, time-interval-by-memory, include-last-step, for-adjoint-simulations) from underscore to hyphen format; updated error message; removed trailing whitespace
docs/sections/parameter_documentation/index.rst	Added documentation for time-interval and include-last-step parameters; added example usage in YAML block
docs/sections/api/index.rst	Reordered API documentation list (moved specfem/macros before specfem/mpi for alphabetical ordering)

---

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

[Copilot]

The documented default value for time-interval is "1 (-> every time step)" but the code returns 0 when the parameter is not provided. This inconsistency between documentation and implementation should be corrected. Either update the default value in the code to return 1, or update the documentation to reflect that the actual default is 0.

Suggested change

	:default value: 1 (-> every time step)
	:default value: 0

[Copilot]

The parameter for-adjoint-simulations (renamed from for_adjoint_simulations) is missing from the documentation. This parameter is used in the code but has no corresponding documentation entry explaining its purpose, default value, and possible values. Documentation should be added for this parameter in the wavefield section.

[Copilot]

The parameter time-interval-by-memory (renamed from time_interval_by_memory) is missing from the documentation. This parameter is used in the code but has no corresponding documentation entry explaining its purpose, default value, and possible values. Documentation should be added for this parameter in the wavefield section.