Skip to content

Commit

Permalink
Improve custom layout docs , fix typo in description of function (#266)
Browse files Browse the repository at this point in the history
* fix typo in to_html.py

* use card_row instead of card_deck (in example in docs) as there is no such function as card_deck

There is no card_deck helper function in to_html.py
  • Loading branch information
Sa-So committed Jun 28, 2023
1 parent 94b5516 commit 4897fad
Show file tree
Hide file tree
Showing 2 changed files with 2 additions and 2 deletions.
2 changes: 1 addition & 1 deletion docs/source/buildcustom.rst
Original file line number Diff line number Diff line change
Expand Up @@ -412,7 +412,7 @@ you ``from explainerdashboard.custom import *``::

def to_html(self, state_dict=None, add_header=True):
html = to_html.title(self.title)
html += to_html.card_deck(
html += to_html.card_row(
self.confusion.to_html(state_dict, add_header=False),
self.contrib.to_html(state_dict, add_header=False)
)
Expand Down
2 changes: 1 addition & 1 deletion explainerdashboard/to_html.py
Original file line number Diff line number Diff line change
Expand Up @@ -182,7 +182,7 @@ def card_rows(*cardrows_list) -> str:


def dashboard_card(title: str = None, description: str = None, url: str = None) -> str:
"""Generate a dashboard description car for ExplainerHub.
"""Generate a dashboard description card for ExplainerHub.
Consists of title, description and url.
"""
return f"""
Expand Down

0 comments on commit 4897fad

Please sign in to comment.