Skip to content

Commit 42f45cf

Browse files
Merge pull request #664 from linsword13/update-dev-guide
Add mention of `get_file_path` util in app dev guide
2 parents 2172872 + e0499bb commit 42f45cf

File tree

1 file changed

+9
-0
lines changed

1 file changed

+9
-0
lines changed

lib/ramble/docs/dev_guides/application_dev_guide.rst

+9
Original file line numberDiff line numberDiff line change
@@ -268,6 +268,15 @@ context. Each context represents a grouping of figures of merit that are
268268
collected together. A figure of merit context can be defined using
269269
:py:meth:`ramble.language.shared_language.figure_of_merit_context`.
270270

271+
^^^^^^^^^^^^^^^^^^
272+
File path handling
273+
^^^^^^^^^^^^^^^^^^
274+
275+
Ramble provides a utility function :py:meth:`ramble.util.file_util.get_file_path`
276+
that should be used when referencing file paths in application definitions. This
277+
helps with Ramble to properly mock out these paths during unit testing, where the
278+
files may not exist under the dry-run setting.
279+
271280
--------------------------
272281
Package Manager Directives
273282
--------------------------

0 commit comments

Comments
 (0)