eWaterCycle / eWaterCycle/grpc4bmi

Mistake in documentation, `BmiClientSubProcess`

Open
#122 0 comments 0 reactions 0 assignees View on GitHub
Dominant language
Python
Stars
5
Forks
5
PR merge metrics
No merged PRs in 30d

Description

In the documentation, [the instructions for `BmiClientSubProcess` ](https://grpc4bmi.readthedocs.io/en/latest/usage.html#python-subprocess)are as follows;

```py
from grpc4bmi.bmi_client_subproc import BmiClientSubProcess

model = BmiClientSubProcess(..)
```

However, this should be:

```py
from grpc4bmi.bmi_client_subproc import BmiClientSubProcess

model = BmiClientSubProcess("..")
```
Note the quotes `"`.

Contributor guide

No contributing guide indexed for this repository

Research direction

Open the Python subprocess instructions in usage.html at the `python-subprocess` section. Correct the `BmiClientSubProcess` example so the package, module, and class placeholder is quoted, then verify the rendered documentation shows the corrected example.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
documentation
Issue type
Documentation
Difficulty
1/5
Estimated time
Under an hour
Activity status
Stale
Clarity
Clearly specified
Newbie friendliness
55/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.