feat(docs): Move docstring and clarify debug
Part-of: <https://dev.funkwhale.audio/funkwhale/funkwhale/-/merge_requests/2643>
This commit is contained in:
		
							parent
							
								
									43c2861252
								
							
						
					
					
						commit
						4740df9d3c
					
				|  | @ -18,6 +18,24 @@ ENV = env | ||||||
| LOGLEVEL = ( | LOGLEVEL = ( | ||||||
|     "DEBUG" if env.bool("DEBUG", False) else env("LOGLEVEL", default="info").upper() |     "DEBUG" if env.bool("DEBUG", False) else env("LOGLEVEL", default="info").upper() | ||||||
| ) | ) | ||||||
|  | """ | ||||||
|  | Default logging level for the Funkwhale processes. | ||||||
|  | 
 | ||||||
|  | .. note:: | ||||||
|  |     The `DEBUG` variable overrides the `LOGLEVEL` if it is set to `TRUE`. | ||||||
|  | 
 | ||||||
|  |     The `LOGLEVEL` value only applies if `DEBUG` is `false` or not present. | ||||||
|  | 
 | ||||||
|  | Available levels: | ||||||
|  | 
 | ||||||
|  | - ``debug`` | ||||||
|  | - ``info`` | ||||||
|  | - ``warning`` | ||||||
|  | - ``error`` | ||||||
|  | - ``critical`` | ||||||
|  | 
 | ||||||
|  | """ | ||||||
|  | 
 | ||||||
| IS_DOCKER_SETUP = env.bool("IS_DOCKER_SETUP", False) | IS_DOCKER_SETUP = env.bool("IS_DOCKER_SETUP", False) | ||||||
| 
 | 
 | ||||||
| 
 | 
 | ||||||
|  | @ -39,19 +57,6 @@ if env("FUNKWHALE_SENTRY_DSN", default=None) is not None: | ||||||
|     ) |     ) | ||||||
|     sentry_sdk.set_tag("instance", env("FUNKWHALE_HOSTNAME")) |     sentry_sdk.set_tag("instance", env("FUNKWHALE_HOSTNAME")) | ||||||
| 
 | 
 | ||||||
| """ |  | ||||||
| Default logging level for the Funkwhale processes |  | ||||||
| 
 |  | ||||||
| Available levels: |  | ||||||
| 
 |  | ||||||
| - ``debug`` |  | ||||||
| - ``info`` |  | ||||||
| - ``warning`` |  | ||||||
| - ``error`` |  | ||||||
| - ``critical`` |  | ||||||
| 
 |  | ||||||
| """  # pylint: disable=W0105 |  | ||||||
| 
 |  | ||||||
| LOGGING_CONFIG = None | LOGGING_CONFIG = None | ||||||
| logging.config.dictConfig( | logging.config.dictConfig( | ||||||
|     { |     { | ||||||
|  |  | ||||||
		Loading…
	
		Reference in New Issue
	
	 Ciarán Ainsworth
						Ciarán Ainsworth