Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add mention of get_file_path util in app dev guide #664

Merged
merged 1 commit into from
Sep 26, 2024
Merged

Add mention of get_file_path util in app dev guide #664

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 9 additions & 0 deletions lib/ramble/docs/dev_guides/application_dev_guide.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -268,6 +268,15 @@ context. Each context represents a grouping of figures of merit that are
collected together. A figure of merit context can be defined using
:py:meth:`ramble.language.shared_language.figure_of_merit_context`.

^^^^^^^^^^^^^^^^^^
File path handling
^^^^^^^^^^^^^^^^^^

Ramble provides a utility function :py:meth:`ramble.util.file_util.get_file_path`
that should be used when referencing file paths in application definitions. This
helps with Ramble to properly mock out these paths during unit testing, where the
files may not exist under the dry-run setting.

--------------------------
Package Manager Directives
--------------------------
Expand Down