Skip to content

Commit 52002c7

Browse files
author
zhenwei-li
committed
the directory README upgrade
1 parent 7179fbc commit 52002c7

1 file changed

Lines changed: 34 additions & 0 deletions

File tree

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,37 @@
11
# README
22

33
this is dir modules.
4+
5+
## describe
6+
7+
This is a package component that simply handles directories and specific text.
8+
9+
```bash
10+
NAME
11+
common_dir
12+
13+
FUNCTIONS
14+
generate_complex_file_name(output_dir_name, file_name)
15+
the generate complex file name
16+
17+
generate_complex_or_fmt_file_name(output_dir_name, file_name, fmt='%Y%m%d_%H%M%S')
18+
the generate out complex or fmt file name
19+
20+
generate_file_name(output_dir_name, file_name)
21+
the generate out file name
22+
23+
generate_file_name_only(output_dir_name, file_name)
24+
the generate file name only
25+
26+
generate_fmt_file_name(output_dir_name, file_name, fmt='%Y%m%d_%H%M%S')
27+
the generate out with fmt file name
28+
29+
mk_children_dir(output_dir_name, sub_dir_name)
30+
the initialize children dir
31+
32+
mk_dir(output_dir_name)
33+
the initialize global output dir
34+
35+
mk_output_dir(output_dir_name)
36+
the initialize output dir
37+
```

0 commit comments

Comments
 (0)