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

Upgrade Deserialization Docs #332

Merged
merged 4 commits into from
Sep 12, 2023
Merged

Upgrade Deserialization Docs #332

merged 4 commits into from
Sep 12, 2023

Conversation

nh916
Copy link
Contributor

@nh916 nh916 commented Sep 11, 2023

Description

updated documentation on working with cript.API.search, paginator, and deserializing JSON to nodes

Changes

  • added link at end of valid_search_modes.py to cript.API.search()
  • added documentation for deserialization of JSON to node to API.search
  • collapsed cript.API.search code examples to be easier and more compact
  • copied over code example from load_nodes_from_json documentation to cript.API.search to make working with search documentation easier.
  • added links to Paginator and load_nodes_from_json in notes of cript.API.search for user to easily flip to those pages

Screenshots

image

SearchModes link additions


api search code example addition documentation

JSON to node code examples


load_nodes_from_json code example documentation

slightly changed code example to be more understandable

Tests

Known Issues

Notes

We can merge this into SDK before or after release of v2.1.0

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.

* collapsed `cript.API.search` code examples to be easier and more compact
* copied over code example from `load_nodes_from_json` documentation to cript.API.search to make working with search documentation easier.
* added links to `Paginator` and `load_nodes_from_json` in notes of `cript.API.search` for user to easily flip to those pages
@trunk-io
Copy link

trunk-io bot commented Sep 11, 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 September 11, 2023 21:40
@nh916 nh916 merged commit 07d5d67 into develop Sep 12, 2023
13 checks passed
@nh916 nh916 deleted the upgrade-documentation branch September 12, 2023 00:07
@nh916 nh916 changed the title Upgrade documentation Improve Deserialization Docs Sep 12, 2023
@nh916 nh916 changed the title Improve Deserialization Docs Upgrade Deserialization Docs Sep 12, 2023
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