Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[Bug] Inconsistency between documentation and code: 'hostname' vs 'host' parameter #541

Open
mohsinalipro opened this issue Sep 29, 2024 · 1 comment
Assignees
Labels
bug Something isn't working

Comments

@mohsinalipro
Copy link

The problem

There's an inconsistency between the documentation and the actual implementation regarding the parameter name for the router's address in the AsusRouter class. The documentation shows 'hostname' in the example, but the actual implementation uses 'host'. This causes confusion and errors when trying to use the library as per the documentation.

Python version

Python 3.10.12

Your device model

RT-AC68U

Firmware type

Merlin

Firmware version

386.13

@mohsinalipro mohsinalipro added the bug Something isn't working label Sep 29, 2024
@github-project-automation github-project-automation bot moved this to Incoming in AsusRouter Sep 29, 2024
@Vaskivskyi
Copy link
Owner

Hello, @mohsinalipro, both the dev and the main branches of the repository have AsusRouter class defined with a hostname argument.

def __init__(
self,
hostname: str,
username: str,
password: str,
port: Optional[int] = None,
use_ssl: bool = False,
cache_time: Optional[float] = None,
session: Optional[aiohttp.ClientSession] = None,
dumpback: Optional[Callable[..., Awaitable[None]]] = None,
): # pylint: disable=too-many-arguments

In which part of the code did you find host?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working
Projects
Status: Incoming
Development

No branches or pull requests

2 participants