docs: enhance the 'download sources' command info (#602)

crowdin · Jun 20, 2023 · cb2e966 · cb2e966
1 parent d6eb0a1
commit cb2e966
Showing 1 changed file with 4 additions and 0 deletions.
diff --git a/website/mantemplates/crowdin-download-sources.adoc b/website/mantemplates/crowdin-download-sources.adoc
@@ -14,3 +14,7 @@ include::{includedir}/{command}.adoc[tag=picocli-generated-man-section-commands]
 include::{includedir}/{command}.adoc[tag=picocli-generated-man-section-options]
 
 include::{includedir}/{command}.adoc[tag=picocli-generated-man-section-footer]
+
+=== Notes
+
+- This command relies on the source files and folder structure in Crowdin and will download them to the same structure locally. If you're using the `preserve_hierarchy` option as `false`, it may skip directories when uploading sources to Crowdin and as a result the downloaded sources may be placed in a different location than the original ones. It's highly recommended to use `preserve_hierarchy": true` if you want to use this command.