Skip to content

Commit

Permalink
Merge pull request #664 from linsword13/update-dev-guide
Browse files Browse the repository at this point in the history
Add mention of `get_file_path` util in app dev guide
  • Loading branch information
douglasjacobsen authored Sep 26, 2024
2 parents 2172872 + e0499bb commit 42f45cf
Showing 1 changed file with 9 additions and 0 deletions.
9 changes: 9 additions & 0 deletions lib/ramble/docs/dev_guides/application_dev_guide.rst
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

0 comments on commit 42f45cf

Please sign in to comment.