QagentS commited on
Commit
59c3912
·
verified ·
1 Parent(s): 648ac52

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +6 -7
README.md CHANGED
@@ -52,20 +52,19 @@ The model is open source under apache 2.0. License
52
 
53
 
54
  from pip_library_parser import CodeToDocGenerator
55
- from atlassian import Jira
56
 
57
- import torch
58
- torch.set_default_device("cuda")
 
59
 
60
  # Instantiate the CodeToDocGenerator
61
  generator = CodeToDocGenerator()
62
 
63
  # Generate docstrings for the module's functions and methods
64
- module = Jira
65
- module_name = "atlassian.Jira"
66
-
67
  docs = generator.generate_module_docs(module, module_name)
68
- print(docs)
 
 
69
  ```
70
 
71
  ```python
 
52
 
53
 
54
  from pip_library_parser import CodeToDocGenerator
 
55
 
56
+ # Replace 'your_module' and 'YourModule' with the actual module and module name
57
+ module_name = 'your_module'
58
+ module = __import__(module_name)
59
 
60
  # Instantiate the CodeToDocGenerator
61
  generator = CodeToDocGenerator()
62
 
63
  # Generate docstrings for the module's functions and methods
 
 
 
64
  docs = generator.generate_module_docs(module, module_name)
65
+
66
+ # 'docs' now contains a dictionary mapping function/method names to their generated docstrings
67
+
68
  ```
69
 
70
  ```python