Skip to content

Commit

Permalink
Add docstring to change_dir_if_bundle
Browse files Browse the repository at this point in the history
  • Loading branch information
NHDaly committed Jul 25, 2018
1 parent 3b19bce commit 95c36e1
Showing 1 changed file with 15 additions and 0 deletions.
15 changes: 15 additions & 0 deletions src/ApplicationBuilder.jl
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,21 @@ module App

using Compat

"""
change_dir_if_bundle()
Change current working directory to the directory containing the App's
resources.
The behavior of this function depends on how it's called. If this code is called
from within an Application compiled by ApplicationBuilder it will `cd` to the
directory containing the App's resources. Otherwise, it will do nothing.
Apps that access any files through relative paths should call this function in
their `julia_main()`.
"""
function change_dir_if_bundle end

@static if Compat.Sys.isapple()
if get(ENV, "COMPILING_APPLE_BUNDLE", "false") == "true"
function change_dir_if_bundle()
Expand Down

0 comments on commit 95c36e1

Please sign in to comment.