Compare commits
7 Commits
be5c95bbdf
...
1f440a4b66
| Author | SHA1 | Date | |
|---|---|---|---|
| 1f440a4b66 | |||
| 4f1443e9c8 | |||
| ae8fb80537 | |||
| 57ca035bb6 | |||
| 818455fd40 | |||
| 33ae2bae1a | |||
| e9a75a4a68 |
@ -171,14 +171,15 @@ class Message():
|
|||||||
"""
|
"""
|
||||||
Create a Message from the given file. Expects the following file structures:
|
Create a Message from the given file. Expects the following file structures:
|
||||||
For '.txt':
|
For '.txt':
|
||||||
* TagLine
|
* TagLine [Optional]
|
||||||
* Question.txt_header
|
* Question.txt_header
|
||||||
* Question
|
* Question
|
||||||
* Answer.txt_header
|
* Answer.txt_header [Optional]
|
||||||
|
# Answer [Optional]
|
||||||
For '.yaml':
|
For '.yaml':
|
||||||
* Question.yaml_key: single or multiline string
|
* Question.yaml_key: single or multiline string
|
||||||
* Answer.yaml_key: single or multiline string
|
* Answer.yaml_key: single or multiline string [Optional]
|
||||||
* Message.tags_yaml_key: list of strings
|
* Message.tags_yaml_key: list of strings [Optional]
|
||||||
Returns 'None' if the message does not fulfill the tag requirements.
|
Returns 'None' if the message does not fulfill the tag requirements.
|
||||||
"""
|
"""
|
||||||
if not file_path.exists():
|
if not file_path.exists():
|
||||||
@ -222,7 +223,7 @@ class Message():
|
|||||||
|
|
||||||
def to_file(self, file_path: Optional[pathlib.Path]) -> None:
|
def to_file(self, file_path: Optional[pathlib.Path]) -> None:
|
||||||
"""
|
"""
|
||||||
Write Message to the given file. Creates the following file structures:
|
Write a Message to the given file. Creates the following file structures:
|
||||||
For '.txt':
|
For '.txt':
|
||||||
* TagLine
|
* TagLine
|
||||||
* Question.txt_header
|
* Question.txt_header
|
||||||
|
|||||||
Loading…
x
Reference in New Issue
Block a user