add ifues description

KazuCocoa · KazuCocoa · commit 175ab43df3e3 · 2019-03-12T18:29:13.000+09:00
diff --git a/lib/appium_lib_core/common/base/driver.rb b/lib/appium_lib_core/common/base/driver.rb
@@ -426,12 +426,17 @@ def push_file(path, filedata)
         #                      of the corresponding application container.
         #                      Otherwise the root folder is considered as / on Android and on iOS it is a media folder root
         #                      (real devices only).
+        #                      Only pulling files from application containers is supported for iOS Simulator.
+        #                      Provide the remote path in format <code>@bundle.identifier:container_type/relative_path_in_container</code>
+        #                      (Make sure this in ifuse doc)
+        #
         # @return [Base64-decoded] Base64 decoded data
         #
         # @example
         #
         #   @driver.pull_file '/local/data/some/path'     #=> Get the file at that path
         #   @driver.pull_file 'Shenanigans.app/some/file' #=> Get 'some/file' from the install location of Shenanigans.app
+        #   @driver.pull_file '@com.appium.example/Documents/file.txt' #=> Get 'file.txt' in @com.appium.example/Documents
         #
         def pull_file(path)
           @bridge.pull_file(path)
@@ -444,20 +449,26 @@ def pull_file(path)
         # its container on the internal file system.
         #
         # {https://github.com/libimobiledevice/ifuse iFuse GitHub page6}
+        #
         # {https://github.com/osxfuse/osxfuse/wiki/FAQ osxFuse FAQ}
+        #
         # {https://developer.android.com/studio/debug/ 'Debug Your App' developer article}
         #
         # @param [String] path Absolute path to the folder.
         #                      If the path starts with <em>@applicationId/</em> prefix, then the folder will be pulled
         #                      from the root of the corresponding application container.
         #                      Otherwise the root folder is considered as / on Android and on iOS it is a media folder root
         #                      (real devices only).
+        #                      Only pulling files from application containers is supported for iOS Simulator.
+        #                      Provide the remote path in format <code>@bundle.identifier:container_type/relative_path_in_container</code>
+        #                      (Make sure this in ifuse doc)
         #
         # @return [Base64-decoded] Base64 decoded data which is zip archived
         #
         # @example
         #
         #   @driver.pull_folder '/data/local/tmp' #=> Get the folder at that path
+        #   @driver.pull_file '@com.appium.example/Documents' #=> Get 'Documents' in @com.appium.example
         #
         def pull_folder(path)
           @bridge.pull_folder(path)

Original file line number	Diff line number	Diff line change
`@@ -426,12 +426,17 @@ def push_file(path, filedata)`
`426`	`426`	`# of the corresponding application container.`
`427`	`427`	`# Otherwise the root folder is considered as / on Android and on iOS it is a media folder root`
`428`	`428`	`# (real devices only).`
	`429`	`+ # Only pulling files from application containers is supported for iOS Simulator.`
	`430`	`+ # Provide the remote path in format <code>@bundle.identifier:container_type/relative_path_in_container</code>`
	`431`	`+ # (Make sure this in ifuse doc)`
	`432`	`+ #`
`429`	`433`	`# @return [Base64-decoded] Base64 decoded data`
`430`	`434`	`#`
`431`	`435`	`# @example`
`432`	`436`	`#`
`433`	`437`	`# @driver.pull_file '/local/data/some/path' #=> Get the file at that path`
`434`	`438`	`# @driver.pull_file 'Shenanigans.app/some/file' #=> Get 'some/file' from the install location of Shenanigans.app`
	`439`	`+ # @driver.pull_file '@com.appium.example/Documents/file.txt' #=> Get 'file.txt' in @com.appium.example/Documents`
`435`	`440`	`#`
`436`	`441`	`def pull_file(path)`
`437`	`442`	`@bridge.pull_file(path)`
`@@ -444,20 +449,26 @@ def pull_file(path)`
`444`	`449`	`# its container on the internal file system.`
`445`	`450`	`#`
`446`	`451`	`# {https://github.com/libimobiledevice/ifuse iFuse GitHub page6}`
	`452`	`+ #`
`447`	`453`	`# {https://github.com/osxfuse/osxfuse/wiki/FAQ osxFuse FAQ}`
	`454`	`+ #`
`448`	`455`	`# {https://developer.android.com/studio/debug/ 'Debug Your App' developer article}`
`449`	`456`	`#`
`450`	`457`	`# @param [String] path Absolute path to the folder.`
`451`	`458`	`# If the path starts with <em>@applicationId/</em> prefix, then the folder will be pulled`
`452`	`459`	`# from the root of the corresponding application container.`
`453`	`460`	`# Otherwise the root folder is considered as / on Android and on iOS it is a media folder root`
`454`	`461`	`# (real devices only).`
	`462`	`+ # Only pulling files from application containers is supported for iOS Simulator.`
	`463`	`+ # Provide the remote path in format <code>@bundle.identifier:container_type/relative_path_in_container</code>`
	`464`	`+ # (Make sure this in ifuse doc)`
`455`	`465`	`#`
`456`	`466`	`# @return [Base64-decoded] Base64 decoded data which is zip archived`
`457`	`467`	`#`
`458`	`468`	`# @example`
`459`	`469`	`#`
`460`	`470`	`# @driver.pull_folder '/data/local/tmp' #=> Get the folder at that path`
	`471`	`+ # @driver.pull_file '@com.appium.example/Documents' #=> Get 'Documents' in @com.appium.example`
`461`	`472`	`#`
`462`	`473`	`def pull_folder(path)`
`463`	`474`	`@bridge.pull_folder(path)`