Skip to content

Commit 2aef265

Browse files
committed
Added details on environment variables to docstring for ExportServer.referer and ExportServer.user_agent properties.
1 parent ead44f7 commit 2aef265

File tree

1 file changed

+5
-4
lines changed

1 file changed

+5
-4
lines changed

highcharts_core/headless_export.py

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -107,7 +107,8 @@ def __init__(self, **kwargs):
107107

108108
@property
109109
def referer(self) -> Optional[str]:
110-
"""The referer to use when making requests to the export server. Defaults to
110+
"""The referer to use when making requests to the export server. Defaults to the
111+
``HIGHCHARTS_EXPORT_SERVER_REFERER`` environment variable if present, otherwise defaults to
111112
``'https://www.highcharts.com'``.
112113
113114
:rtype: :class:`str <python:str>` or :obj:`None <python:None>`
@@ -124,15 +125,15 @@ def referer(self, value):
124125

125126
@property
126127
def user_agent(self) -> Optional[str]:
127-
"""The user agent to use when making requests to the export server. Defaults to
128-
``Highcharts for Python / v.<VERSION NUMBER>.
128+
"""The user agent to use when making requests to the export server. Defaults to the ``HIGHCHARTS_EXPORT_SERVER_USER_AGENT`` environment variable if present, otherwise defaults to
129+
``Highcharts Core for Python / v.<VERSION NUMBER>.
129130
130131
:rtype: :class:`str <python:str>` or :obj:`None <python:None>`
131132
"""
132133
if self._user_agent:
133134
return self._user_agent
134135

135-
return f'Highcharts for Python / v.{highcharts_version.__version__}'
136+
return f'Highcharts Core for Python / v.{highcharts_version.__version__}'
136137

137138
@user_agent.setter
138139
def user_agent(self, value):

0 commit comments

Comments
 (0)