plotly / plotly/dash-auth

[Feature Request] More documentaion for new dash-auth 2.2.0 package

Open
#150 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Python
Stars
135
Forks
67
PR merge metrics
No merged PRs in 30d

Description

Dear,

I would like to request more documentation for the new version of Dash-Auth (version 2.2.0). The explanation of defining public routes and public callbacks is not clear in the current documentation. Although I have reviewed the documentation, it seems insufficient.

For example, I don't have public routes, but I do have some callbacks to open modals or new pages from a sidebar. I am encountering an error related to the line if inp["property"] == "pathname", and when I replace it with if isinstance(inp, dict) and inp.get("property") == "pathname", the issue goes away. However, I understand that modifying the library in this way is not the correct approach.

It would be immensely helpful to have additional examples for debugging purposes.

Thank you.

Contributor guide

Open the contributing guide

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

Start by reviewing the current Dash-Auth 2.2.0 documentation covering public routes and public callbacks, then reproduce the reported callback error involving inp["property"] == "pathname". Done means the documentation clearly explains this use case and includes examples or debugging guidance for callbacks that open modals or pages.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
documentation
Issue type
Documentation
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.