MagicStack / MagicStack/asyncpg

README missing Database Port number in the example.

Open
#469 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Python
Stars
8.1k
Forks
468
PR merge metrics
No merged PRs in 30d

Description

* **asyncpg version**:
* **PostgreSQL version**:
* **Do you use a PostgreSQL SaaS? If so, which? Can you reproduce
the issue with a local PostgreSQL install?**:
* **Python version**:
* **Platform**:
* **Do you use pgbouncer?**:
* **Did you install asyncpg with pip?**:
* **If you built asyncpg locally, which version of Cython did you use?**:
* **Can the issue be reproduced under both asyncio and
[uvloop](https://github.com/magicstack/uvloop)?**:

Not a bug or issue, I saw the example in the README section..

```
import asyncio
import asyncpg

async def run():
conn = await asyncpg.connect(user='user', password='password',
database='database', host='127.0.0.1')
values = await conn.fetch('''SELECT * FROM mytable''')
await conn.close()

loop = asyncio.get_event_loop()
loop.run_until_complete(run())
```
A database port number is missing in the example, I know Postgres default port is 5432, but in example if we give the details about the port it will be more clear to reader about the port parameter to use for different database instance.. Was it intentional to leave port number or its error ?

--Raghav

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Open the README section containing the asyncpg.connect example and inspect how connection parameters are documented. Update the example to make the database port usage clear, then check that the code remains a valid PostgreSQL connection example. With no recent response for years, confirm the issue is still relevant before starting.

Written by the indexing model from the issue text.

Assessment

Tech stack
postgresql, python
Domain
databases, documentation
Issue type
Documentation
Difficulty
1/5
Estimated time
Under an hour
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.