Преглед изворни кода

docs: fix wording in attachments

Mikael Koli пре 4 година
родитељ
комит
a5fdbf9b1e
1 измењених фајлова са 5 додато и 5 уклоњено
  1. 5 5
      docs/tutorials/attachments.rst

+ 5 - 5
docs/tutorials/attachments.rst

@@ -27,24 +27,24 @@ attachments. You may pass a list, a single object or
 a dict. If you pass a dict, the key is used to determine
 the name of the attachment and possibly the type.
 
-Here is a list of supported value formats if dict is passed:
+Here is a list of supported value formats if ``dict`` is passed to attachments:
 
 ================ =============== =================================================================
-Value type       Key as          Value as
+Value type       Dict key        Dict value
 ================ =============== =================================================================
 ``pd.Series``    Attachment name Turned to CSV, XLSX, HTML etc. depending on file extension in key
 ``pd.DataFrame`` Attachment name Turned to CSV, XLSX, HTML etc. depending on file extension in key           
 ``str``          Attachment name Attachment content as raw text
 ``bytes``        Attachment name Attachment content as raw bytes
-``pathlib.Path`` Attachment name Content of the file read as the content of the attachment
+``pathlib.Path`` Attachment name Path to a file that is attached (using key as the file name)
 ================ =============== =================================================================
 
-Here is a list of supported value formats if list or single object is passed:
+Here is a list of supported value formats if ``list`` or single object is passed to attachments:
 
 ================ =============== =========================================================
 Type             Attachment name Value
 ================ =============== =========================================================
 ``pathlib.Path`` From file name  Content of the file read as the content of the attachment
-``str``          From file name  Considered as file path, handled the same as file path
+``str``          From file name  Considered as file path, handled the same as above
 ================ =============== =========================================================