Skip to content

Enforce Docstring Style Guidelines #592

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.

Sign up for GitHub

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

Jump to bottom
Closed
2 tasks
rmorshea opened this issue Jan 16, 2022 · 0 comments · Fixed by #667
Closed
2 tasks

Enforce Docstring Style Guidelines #592

rmorshea opened this issue Jan 16, 2022 · 0 comments · Fixed by #667
Labels
priority-3-low May be resolved one any timeline. type-docs About changes and updates to documentation
Milestone
1.0.0

Comments

@rmorshea
Copy link
Collaborator

rmorshea commented Jan 16, 2022 •
edited
Loading

Current Situation

Right now we don't enforce any particular docstring style

Proposed Actions

Enforce Google-style docstrings with Pydocstyle.

Pydocstyle hasn't cut a release that includes support for hanging indents, but support has been merged to main. Thus we should install from this commit until a release is made:

pip install "git+https://github.com/PyCQA/pydocstyle.git@bd4993345a241bd0d5128f21de56394b1cde3714#egg=pydocstyle"

Work Items

  • enforce docstring style with pydocstyle
  • add comment explaining why we install from a specific commit on github
@rmorshea rmorshea added flag-triage Not prioritized. priority-3-low May be resolved one any timeline. type-docs About changes and updates to documentation and removed flag-triage Not prioritized. labels Jan 16, 2022
@rmorshea rmorshea added this to the 1.0 milestone Jan 16, 2022
@Archmonger Archmonger mentioned this issue Feb 16, 2022
Merged
rmorshea added a commit that referenced this issue Feb 16, 2022
@rmorshea
fix #592
7a08ae0 
In short, because components do not have a node in the model state tree
managed by the layout, keys for elements in the components were being
registered to the parent of the component rather than to a node for
the component which contained the elements.

The short-term solution was to make it so components wrap their
contents in a div without a key. The long-term solution is to
refactor the Layout() and give components a dedicated node in the
model state tree
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
priority-3-low May be resolved one any timeline. type-docs About changes and updates to documentation
Projects
None yet
Milestone
1.0.0
Development

Successfully merging a pull request may close this issue.

Fix 663 reactive-python/reactpy
1 participant
@rmorshea