Skip to content

Commit

Permalink
Add troubleshooting note in CONTRIBUTING.md (#2110)
Browse files Browse the repository at this point in the history
* Update CONTRIBUTING.md

Signed-off-by: Sajid Alam <sajid_alam@mckinsey.com>

* add suppressions for too many args

Signed-off-by: Sajid Alam <sajid_alam@mckinsey.com>

* lint

Signed-off-by: Sajid Alam <sajid_alam@mckinsey.com>

* remove useless suppressions

Signed-off-by: Sajid Alam <sajid_alam@mckinsey.com>

* Update apps.py

Signed-off-by: Sajid Alam <sajid_alam@mckinsey.com>

* Update Makefile

Signed-off-by: Sajid Alam <sajid_alam@mckinsey.com>

* fix

Signed-off-by: Sajid Alam <sajid_alam@mckinsey.com>

* Update catalog.py

Signed-off-by: Sajid Alam <sajid_alam@mckinsey.com>

* Update catalog.py

Signed-off-by: Sajid Alam <sajid_alam@mckinsey.com>

* Update catalog.py

Signed-off-by: Sajid Alam <sajid_alam@mckinsey.com>

* revert and change max positional args

Signed-off-by: Sajid Alam <sajid_alam@mckinsey.com>

* disable too-many-positional-arguments

Signed-off-by: Sajid Alam <sajid_alam@mckinsey.com>

* Update Makefile

Signed-off-by: Sajid Alam <sajid_alam@mckinsey.com>

---------

Signed-off-by: Sajid Alam <sajid_alam@mckinsey.com>
  • Loading branch information
SajidAlamQB authored Sep 30, 2024
1 parent bed71c9 commit 03d4c9b
Show file tree
Hide file tree
Showing 4 changed files with 8 additions and 4 deletions.
5 changes: 5 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -139,6 +139,11 @@ Now you're ready to begin development. Start the development server:
npm start
```

> _*Note*_: If you face any issues running this, we recommend installing Node.js v18:
>
> 1. Delete `package-lock.json` and `node_modules`.
> 2. Run `npm install` to reinstall dependencies.
This will serve the app at [localhost:4141](http://localhost:4141/), and watch files in `/src` for changes. It will also update the `/lib` directory, which contains a Babel-compiled copy of the source. This directory is exported to `npm`, and is used when importing as a React component into another application. It is updated automatically when you save in case you need to test/debug it locally (e.g. with `npm link`). You can also update it manually, by running

```bash
Expand Down
2 changes: 1 addition & 1 deletion package/.pylintrc
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,7 @@ confidence=
# --enable=similarities". If you want to run only the classes checker, but have
# no Warning level messages displayed, use"--disable=all --enable=classes
# --disable=W"
disable=ungrouped-imports,attribute-defined-outside-init,too-many-arguments,duplicate-code,fixme
disable=ungrouped-imports,attribute-defined-outside-init,too-many-arguments,duplicate-code,too-many-positional-arguments,fixme

# Enable the message, report, category or checker with the given id(s). You can
# either give multiple identifier separated by comma (,) or put this option
Expand Down
2 changes: 1 addition & 1 deletion package/kedro_viz/api/apps.py
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@ def _create_base_api_app() -> FastAPI:
@app.middleware("http")
async def set_secure_headers(request, call_next):
response = await call_next(request)
secure_headers.framework.fastapi(response)
secure_headers.framework.fastapi(response) # pylint: disable=no-member
return response

return app
Expand Down
3 changes: 1 addition & 2 deletions package/kedro_viz/data_access/repositories/catalog.py
Original file line number Diff line number Diff line change
Expand Up @@ -131,8 +131,7 @@ def get_dataset(self, dataset_name: str) -> Optional["AbstractDataset"]:
else: # pragma: no cover
dataset_obj = self._catalog._get_dataset(dataset_name)
except DatasetNotFoundError:
# pylint: disable=abstract-class-instantiated
dataset_obj = MemoryDataset() # type: ignore[abstract]
dataset_obj = MemoryDataset() # pylint: disable=abstract-class-instantiated

return dataset_obj

Expand Down

0 comments on commit 03d4c9b

Please sign in to comment.