From 7934fb3a7a638fe2eb32ef36a421f7e51fd645b4 Mon Sep 17 00:00:00 2001
From: Daniel <d.hornung@indiscale.com>
Date: Wed, 9 Apr 2025 15:16:58 +0200
Subject: [PATCH] DOCS: Small docstring fix.
---
src/linkahead/common/models.py | 32 +++++++++++++++++---------------
1 file changed, 17 insertions(+), 15 deletions(-)
diff --git a/src/linkahead/common/models.py b/src/linkahead/common/models.py
index 6de27153..a3b4683a 100644
--- a/src/linkahead/common/models.py
+++ b/src/linkahead/common/models.py
@@ -2315,21 +2315,23 @@ class File(Record):
look at `test_files.py` in the Python integration tests of the
`load_files.py` script in the advanced user tools.
- @param name: A name for this file record (That's an entity name - not to be
- confused with the last segment of the files path).
- @param id: An ID.
- @param description: A description for this file record.
- @param path: The complete path, including the file name, of the file in the
- server's "caosroot" file system.
- @param file: A local path or python file object. The file designated by
- this argument will be uploaded to the server via HTTP.
- @param pickup: A file/folder in the DropOffBox (the server will move that
- file into its "caosroot" file system).
- @param thumbnail: (Local) filename to a thumbnail for this file.
- @param properties: A list of properties for this file record. @todo is this
- implemented?
- @param from_location: Deprecated, use `pickup` instead.
-
+ @param name
+ A name for this file *Record* (That's an entity name - not to be confused with the last
+ segment of the files path).
+ @param id
+ An ID.
+ @param description
+ A description for this file record.
+ @param path
+ The complete path, including the file name, of the file in the server's "caosroot" file
+ system.
+ @param file
+ A local path or python file object. The file designated by this argument will be uploaded
+ to the server via HTTP.
+ @param thumbnail
+ (Local) filename to a thumbnail for this file.
+ @param properties
+ A list of properties for this file record. @todo is this implemented?
"""
def __init__(
--
GitLab