Fix documentation warnings #3425
Conversation
|
The issue with the compose method is that it is excluded from the docs, but if it is linked from elsewhere, we either link to something else or we make sure that App.compose is documented as well. |
Filter out only `__init__` and private members.
guy-av
force-pushed
the
fix/documentation-warnings
branch
from
9ea9bd3 to
e9a67c0
Compare
|
@davep made sure the filters in |
| @@ -165,6 +165,7 @@ nav: | |||
| - "widgets/tabbed_content.md" | |||
| - "widgets/tabs.md" | |||
| - "widgets/text_area.md" | |||
| - "widgets/toast.md" | |||
There was a problem hiding this comment.
My memory is hazy, but I'm sure we left toast out of the widget list as it's not really a "public-facing" widget; it's more of an internal support widget for the default implementation of App.notify.
| @@ -174,6 +175,7 @@ nav: | |||
| - "api/color.md" | |||
| - "api/command.md" | |||
| - "api/containers.md" | |||
| - "api/content_switcher.md" | |||
There was a problem hiding this comment.
Given that ContentSwitcher is within the widgets, I'm wondering why there is an api/content_switcher.md at all.
@guy-av Forgive me, I may have missed some context here. Another look? Is this something I've looked at before? |
Actually didn't mean to tag you 😅 sorry about that. |
| @@ -825,7 +825,7 @@ def get_option(self, option_id: str) -> Option: | |||
| """ | |||
| return self.get_option_at_index(self.get_option_index(option_id)) | |||
|
|
|||
| def get_option_index(self, option_id): | |||
| def get_option_index(self, option_id: str): | |||
There was a problem hiding this comment.
Can we have a return type here.
|
I'm closing this as it got stale and was superseded by the PR linked above. |
Please review the following checklist.
textual.app.App.compose()doesn't seem to appear in the reference section of the docs hence breaking a specific link on theApp basicspage.Resolves #2699