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

Fix guidance around modifying theme attributes #119

Open
jsoconno opened this issue Aug 15, 2021 · 0 comments
Open

Fix guidance around modifying theme attributes #119

jsoconno opened this issue Aug 15, 2021 · 0 comments
Assignees
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers

Comments

@jsoconno
Copy link
Owner

jsoconno commented Aug 15, 2021

Describe the bug
The documentation about how to modify themes is outdated and inaccurate.

To Reproduce
Steps to reproduce the behavior:

  1. Go to the documentation
  2. Read the steps
  3. Try to implement them and watch it fail

Expected behavior
You should be able to follow the documentation directly and have it work. We should probably break themes into two sections. One for just the plain vanilla using an exiting theme as is and another that shows how you take modify the Theme object by running from architectures.themes.settings import * and passing settings as an object. For example:

from architecture.themes import DarkMode
from architecture.themes.settings import GraphSettings

graph_settings = GraphSettings(color="red")
theme = DarkMode(graph_settings=graph_settings)

with Graph("Architecture Name", theme = theme):
    pass

Screenshots
None.

Desktop (please complete the following information):
All.

Additional context
None.

@jsoconno jsoconno added documentation Improvements or additions to documentation good first issue Good for newcomers labels Aug 15, 2021
@reillyjodonnell reillyjodonnell self-assigned this Aug 17, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers
Projects
None yet
Development

No branches or pull requests

2 participants