Commit 2aef265

committed

Added details on environment variables to docstring for ExportServer.referer and ExportServer.user_agent properties.

1 parent ead44f7 commit 2aef265Copy full SHA for 2aef265

File tree

1 file changed

-4

lines changed

highcharts_core
- headless_export.py

1 file changed

-4

lines changed

`‎highcharts_core/headless_export.py‎`

Lines changed: 5 additions & 4 deletions

Original file line number	Diff line number	Diff line change
`@@ -107,7 +107,8 @@ def __init__(self, **kwargs):`
`107`	`107`
`108`	`108`	`@property`
`109`	`109`	`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
`111`	`112`	``'https://www.highcharts.com'``.
`112`	`113`
`113`	`114`	:rtype: :class:`str <python:str>` or :obj:`None <python:None>`
`@@ -124,15 +125,15 @@ def referer(self, value):`
`124`	`125`
`125`	`126`	`@property`
`126`	`127`	`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>.
`129`	`130`
`130`	`131`	:rtype: :class:`str <python:str>` or :obj:`None <python:None>`
`131`	`132`	`"""`
`132`	`133`	`if self._user_agent:`
`133`	`134`	`return self._user_agent`
`134`	`135`
`135`		`- return f'Highcharts for Python / v.{highcharts_version.__version__}'`
	`136`	`+ return f'Highcharts Core for Python / v.{highcharts_version.__version__}'`
`136`	`137`
`137`	`138`	`@user_agent.setter`
`138`	`139`	`def user_agent(self, value):`

0 commit comments

Comments

(0)

Navigation Menu

Search code, repositories, users, issues, pull requests...

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Commit 2aef265

File tree

1 file changed

1 file changed

`‎highcharts_core/headless_export.py‎`

0 commit comments