Skip to content

docs: Document the SeismicModel fs parameter - #3089

Open
ada-wh525 wants to merge 1 commit into
devitocodes:mainfrom
ada-wh525:ada-wh525/document-fs-parameter
Open

ada-wh525 wants to merge 1 commit into
devitocodes:mainfrom
ada-wh525:ada-wh525/document-fs-parameter

Conversation

@ada-wh525

Copy link
Copy Markdown

Document the missing fs parameter in the SeismicModel docstring, including its default value and how it configures a free surface at the top of the model without an absorbing layer there.

Fixes #2440.

Validation: Python syntax and added-line formatting checks passed. Confirmed that only the docstring changed. The full test suite and pre-commit were not run.

@mloubout mloubout added the examples examples label Oct 24, 2026
@codecov

codecov Bot commented Oct 24, 2026 •

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 79.80%. Comparing base (7a426df) to head (e207b44).
⚠️ Report is 4 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff             @@
##             main    #3089      +/-   ##
==========================================
- Coverage   84.28%   79.80%   -4.49%     
==========================================
  Files         258      258              
  Lines       57449    57449              
  Branches     4914     4914              
==========================================
- Hits        48421    45847    -2574     
- Misses       8204    10721    +2517     
- Partials      824      881      +57     
Flag Coverage Δ
pytest-gpu-aomp-amdgpuX ?
pytest-gpu-gcc- ?
pytest-gpu-icx- ?
pytest-gpu-nvc-nvidiaX ?

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Harness.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

This branch has not been deployed

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

Labels

examples examples

Projects

None yet

Development

Successfully merging this pull request may close these issues.

fs (free-surface) parameter missing from SeismicModel docstring

2 participants