rahix/openflexure-microscope-server
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Doc strings to imperative mood

Browse source
This commit is contained in:
Julian Stirling 2025-07-10 00:36:23 +01:00
parent dceb640c77
commit f51dae7b3a
10 changed files with 88 additions and 79 deletions
Download patch file Download diff file Expand all files Collapse all files

11
src/openflexure_microscope_server/logging.py
View file

@ -39,9 +39,9 @@ def configure_logging(log_folder):
def retrieve_log() -> PlainTextResponse:
"""
Returns logs since we started running the server, up to a maximum of
250 messages. This log is the one shown in the UI and on the logging page.
"""Return logs since the server started, up to a maximum of 250 messages.
This log is the one shown in the UI and on the logging page.
It does not include any of the ``uvicorn.access`` logs as these are emmitted
every time any API route is called.
@ -53,11 +53,10 @@ def retrieve_log() -> PlainTextResponse:
def retrieve_log_from_file() -> PlainTextResponse:
"""
Returns the full log from the file for downloading.
"""Return the full log from the file for downloading.
Note this is read and then sent as otherwise it causes a RuntimeError if it
is written to while sending through FileResponse
is written to while sending through FileResponse.
"""
if OFM_LOG_FILE is None:
raise RuntimeError(