Skip to content

Commit 5301e67

Browse files
committed
Add a link to Postgres docs for server_settings connect argument
Fix a few broken external links while at it. Closes: #265
1 parent cf523be commit 5301e67

File tree

2 files changed

+17
-12
lines changed

2 files changed

+17
-12
lines changed

.ci/travis-build-docs.sh

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,4 +8,4 @@ if [[ "${BUILD}" != *docs* ]]; then
88
fi
99

1010
pip install -r docs/requirements.txt
11-
make htmldocs
11+
make htmldocs SPHINXOPTS="-q -W -j4"

asyncpg/connection.py

Lines changed: 16 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -198,8 +198,9 @@ def transaction(self, *, isolation='read_committed', readonly=False,
198198
:param deferrable: Specifies whether or not this transaction is
199199
deferrable.
200200
201-
.. _`PostgreSQL documentation`: https://www.postgresql.org/docs/\
202-
current/static/sql-set-transaction.html
201+
.. _`PostgreSQL documentation`:
202+
https://www.postgresql.org/docs/
203+
current/static/sql-set-transaction.html
203204
"""
204205
self._check_open()
205206
return transaction.Transaction(self, isolation, readonly, deferrable)
@@ -208,6 +209,7 @@ def is_in_transaction(self):
208209
"""Return True if Connection is currently inside a transaction.
209210
210211
:return bool: True if inside transaction, False otherwise.
212+
211213
.. versionadded:: 0.16.0
212214
"""
213215
return self._protocol.is_in_transaction()
@@ -449,8 +451,8 @@ async def copy_from_table(self, table_name, *, output,
449451
>>> asyncio.get_event_loop().run_until_complete(run())
450452
'COPY 100'
451453
452-
.. _`COPY statement documentation`: https://www.postgresql.org/docs/\
453-
current/static/sql-copy.html
454+
.. _`COPY statement documentation`:
455+
https://www.postgresql.org/docs/current/static/sql-copy.html
454456
455457
.. versionadded:: 0.11.0
456458
"""
@@ -518,8 +520,8 @@ async def copy_from_query(self, query, *args, output,
518520
>>> asyncio.get_event_loop().run_until_complete(run())
519521
'COPY 10'
520522
521-
.. _`COPY statement documentation`: https://www.postgresql.org/docs/\
522-
current/static/sql-copy.html
523+
.. _`COPY statement documentation`:
524+
https://www.postgresql.org/docs/current/static/sql-copy.html
523525
524526
.. versionadded:: 0.11.0
525527
"""
@@ -585,8 +587,8 @@ async def copy_to_table(self, table_name, *, source,
585587
>>> asyncio.get_event_loop().run_until_complete(run())
586588
'COPY 140000'
587589
588-
.. _`COPY statement documentation`: https://www.postgresql.org/docs/\
589-
current/static/sql-copy.html
590+
.. _`COPY statement documentation`:
591+
https://www.postgresql.org/docs/current/static/sql-copy.html
590592
591593
.. versionadded:: 0.11.0
592594
"""
@@ -1469,7 +1471,8 @@ async def connect(dsn=None, *,
14691471
will be used.
14701472
14711473
:param dict server_settings:
1472-
an optional dict of server parameters.
1474+
an optional dict of server runtime parameters. Refer to
1475+
PostgreSQL documentation for a `list of supported options`_.
14731476
14741477
:param Connection connection_class:
14751478
class of the returned connection object. Must be a subclass of
@@ -1507,8 +1510,10 @@ class of the returned connection object. Must be a subclass of
15071510
(and support for password files in general).
15081511
15091512
.. _SSLContext: https://docs.python.org/3/library/ssl.html#ssl.SSLContext
1510-
.. _create_default_context: https://docs.python.org/3/library/ssl.html#\
1511-
ssl.create_default_context
1513+
.. _create_default_context:
1514+
https://docs.python.org/3/library/ssl.html#ssl.create_default_context
1515+
.. _list of supported options:
1516+
https://www.postgresql.org/docs/current/static/runtime-config.html
15121517
"""
15131518
if not issubclass(connection_class, Connection):
15141519
raise TypeError(

0 commit comments

Comments
 (0)