Skip to content

docs(com1DFA): clarify time-stepping configuration in docs and config file#1286

Merged
fso42 merged 1 commit into
masterfrom
fixCflDocu
Jun 2, 2026
Merged

docs(com1DFA): clarify time-stepping configuration in docs and config file#1286
fso42 merged 1 commit into
masterfrom
fixCflDocu

Conversation

@fso42
Copy link
Copy Markdown
Contributor

@fso42 fso42 commented Jun 2, 2026

  • Updated comment in com1DFACfg.ini to clarify sphKernelRadiusTimeStepping behavior.
  • Revised documentation in com1DFAAlgorithm.rst to explain time-stepping options, including kernel size consistency.
    fixes Wrong info about cfl in docu #1285

@fso42 fso42 requested a review from awirb June 2, 2026 09:32
@fso42 fso42 self-assigned this Jun 2, 2026
@fso42 fso42 added documentation Improvements or additions to documentation bugfix labels Jun 2, 2026
@qltysh
Copy link
Copy Markdown
Contributor

qltysh Bot commented Jun 2, 2026

Qlty


Coverage Impact

This PR will not change total coverage.

Modified Components (1)

RatingComponent% Diff
Coverage rating: C Coverage rating: C
com1DFA
🚦 See full report on Qlty Cloud »

🛟 Help
  • Diff Coverage: Coverage for added or modified lines of code (excludes deleted files). Learn more.

  • Total Coverage: Coverage for the whole repository, calculated as the sum of all File Coverage. Learn more.

  • File Coverage: Covered Lines divided by Covered Lines plus Missed Lines. (Excludes non-executable lines including blank lines and comments.)

    • Indirect Changes: Changes to File Coverage for files that were not modified in this PR. Learn more.

Comment thread avaframe/com1DFA/com1DFACfg.ini Outdated
Comment thread avaframe/com1DFA/com1DFACfg.ini Outdated
… file; fixes #1285

- Updated comment in `com1DFACfg.ini` to clarify `sphKernelRadiusTimeStepping` behavior.
- Revised documentation in `com1DFAAlgorithm.rst` to explain time-stepping options, including kernel size consistency.

docs(com1DFA): improve comments for time-stepping configuration
@fso42 fso42 merged commit ec9b0ec into master Jun 2, 2026
2 checks passed
@fso42 fso42 deleted the fixCflDocu branch June 2, 2026 09:53
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

bugfix documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Wrong info about cfl in docu

2 participants