Skip to content

Extend documentation with an example #5

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

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open

Extend documentation with an example #5

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
2637f9f
Ignore DS Store files
nataliasc Mar 28, 2024
4344543
Add DocumentList example
nataliasc Mar 28, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions .gitignore
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
.DS_Store
# Byte-compiled / optimized / DLL files
__pycache__/
*.py[cod]
Expand Down
8 changes: 4 additions & 4 deletions docs/DocumentsList.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,17 +13,17 @@ Name | Type | Description | Notes
```python
from clarivate.wos_starter.client.models.documents_list import DocumentsList

# TODO update the JSON string below
json = "{}"

json = '{"metadata": {"page": 1, "limit": 1, "total": 305}, "hits": [{"uid": "WOS:A1991KR78500001", "title": "A MODULAR NEURAL NETWORK MODEL OF CONCEPT-ACQUISITION", "types": ["Article"], "sourceTypes": ["Article"], "source": {"sourceTitle": "COGNITIVE SCIENCE", "publishYear": 1991, "publishMonth": "OCT-DEC", "volume": "15", "issue": "4", "pages": {"range": "461-508", "begin": "461", "end": "508", "count": 48}}, "names": {"authors": [{"displayName": "SCHYNS, PG", "wosStandard": "SCHYNS, PG", "researcherId": "AAT-6989-2020"}]}, "links": {"record": [], "references": [], "related": []}, "citations": [], "identifiers": {"doi": "10.1207/s15516709cog1504_1", "issn": "0364-0213"}, "keywords": {"authorKeywords": []}}]}'
# create an instance of DocumentsList from a JSON string
documents_list_instance = DocumentsList.from_json(json)
# print the JSON string representation of the object
print DocumentsList.to_json()
print(documents_list_instance.to_json())

# convert the object into a dict
documents_list_dict = documents_list_instance.to_dict()
# create an instance of DocumentsList from a dict
documents_list_form_dict = documents_list.from_dict(documents_list_dict)
documents_list_form_dict = DocumentsList.from_dict(documents_list_dict)
```
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

Expand Down