Open
Conversation
Reviewer's Guide by SourceryThis pull request focuses on improving the documentation within the Class diagram for Window class documentation improvementsclassDiagram
class Window {
+session: Session
+panes: QueryList[Pane]
+active_pane: Pane
+cmd(cmd: str, *args, target: Optional[str|int]) tmux_cmd
+select_pane(target_pane: str|int) Pane
+split(target: Optional[str|int], start_directory: Optional[str], attach: bool, direction: Optional[PaneDirection], full_window_split: bool, zoom: bool, shell: Optional[str], size: Optional[str|int], environment: Optional[dict]) Pane
+resize(adjustment_direction: Optional[ResizeAdjustmentDirection], adjustment: Optional[int], height: Optional[int], width: Optional[int], expand: Optional[bool], shrink: Optional[bool]) Window
+select_layout(layout: Optional[str]) Window
+set_window_option(option: str, value: str|int) Window
+show_window_options(g: Optional[bool]) WindowOptionDict
+show_window_option(option: str, g: bool) str|int|None
+rename_window(new_name: str) Window
+kill(all_except: Optional[bool]) None
+move_window(destination: str, session: Optional[str]) Window
+select() Window
+new_window(...) Window
}
note for Window "Documentation improvements:
- Enhanced method descriptions
- Clarified parameter types
- Added return type details
- Improved examples
- Marked deprecated methods"
File-Level Changes
Tips and commandsInteracting with Sourcery
Customizing Your ExperienceAccess your dashboard to:
Getting Help
|
![sourcery-ai[bot]](https://avatars.githubusercontent.com/in/48477?s=60&v=4){kind=small}
There was a problem hiding this comment.
Hey @tony - I've reviewed your changes and they look great!
Here's what I looked at during the review
- 🟢 General issues: all looks good
- 🟢 Security: all looks good
- 🟢 Testing: all looks good
- 🟢 Complexity: all looks good
- 🟢 Documentation: all looks good
Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.
Comment on lines
+470
to
474
| if val.isdigit(): | ||
| window_options[key] = int(val) | ||
| else: | ||
| window_options[key] = val | ||
|
|
There was a problem hiding this comment.
suggestion (code-quality): Replace if statement with if expression (assign-if-exp)
Suggested change
| if val.isdigit(): | |
| window_options[key] = int(val) | |
| else: | |
| window_options[key] = val | |
| window_options[key] = int(val) if val.isdigit() else val |
Codecov Report❌ Patch coverage is
Additional details and impacted files@@ Coverage Diff @@
## master #559 +/- ##
==========================================
+ Coverage 79.83% 80.10% +0.27%
==========================================
Files 22 22
Lines 1914 1890 -24
Branches 294 290 -4
==========================================
- Hits 1528 1514 -14
+ Misses 266 259 -7
+ Partials 120 117 -3 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
tony
force-pushed
the
doc-makeover
branch
6 times, most recently
from
0d2e6c8 to
3de6757
Compare
tony
force-pushed
the
doc-makeover
branch
4 times, most recently
from
e0cfc84 to
aececa0
Compare
tony
force-pushed
the
doc-makeover
branch
15 times, most recently
from
ee82522 to
224f487
Compare
tony
force-pushed
the
doc-makeover
branch
2 times, most recently
from
2d098b5 to
1768cb5
Compare
tony
force-pushed
the
master
branch
4 times, most recently
from
0188aed to
ea5b0c4
Compare
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Changes
Streamlining docs for consistency, sustainability.
Summary by Sourcery
Documentation:
Windowclass.