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

Docs Update #420

Merged
merged 1 commit into from
Nov 28, 2023
Merged

Docs Update #420

merged 1 commit into from
Nov 28, 2023

Conversation

nh916
Copy link
Contributor

@nh916 nh916 commented Nov 25, 2023

Description

Updating just the docs, not a release to Pypi

Changes

  • wrote docs for find_children Base method
  • added type hinting to Base.find_childre()
    • added return type
    • wrote clear example with doctest
    • upgraded notes section to be easier to read and understand

Known Issues

Notes

Checklist

  • My name is on the list of contributors (CONTRIBUTORS.md) in the pull request source branch.
  • I have updated the documentation to reflect my changes.
  • My code changes have been verified by automated tests and pass all relevant test scenarios.

* wrote docs for `find_children` Base method

* wrote parameters docs in numpy with typing and explanation
* added return type
* wrote clear example with doctest
* working on note section to be easy to understand and easy to read with good UI and UX

* replace code example focs for `find_children` Base method symbols to be more uniform

* upgraded notes section to be easier to read and understand

* added type hinting to `Base.find_childre()`

* wrote docs for `Base.find_children()` `handled_nodes`

* fixed formatting

* fixed formatting

* fixed formatting

* fixed formatting

* fixed formatting

* formatted with black
Copy link

trunk-io bot commented Nov 25, 2023

Merging to develop in this repository is managed by Trunk.

  • To merge this pull request, check the box to the left or comment /trunk merge below.

@nh916 nh916 requested a review from InnocentBug November 25, 2023 21:18
@nh916 nh916 merged commit 75a2ffc into main Nov 28, 2023
22 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants