Improve Docstrings in Task/braket_simulator #976
Conversation
| Returns: | ||
| BraketEmulatorTask: The current instance with the task results updated. | ||
|
|
||
| Example: |
There was a problem hiding this comment.
same as my previous comment, this needs to use a markdown code block
There was a problem hiding this comment.
also can you actually run these code and copy the important printings back, e.g the printing of task and result
There was a problem hiding this comment.
@shubhusion Just for clarity you all you need to do:
"""
Example:
```python
>>> <example code>
>>> ...
```
"""
| ValueError: If the task has not been submitted yet. | ||
|
|
||
| Example: | ||
| >>> task_spec = BraketTaskSpecification(...) # Task specification setup |
There was a problem hiding this comment.
this needs to be more specific, e.g what does the specification take? and I don't think this is what user will be using. The result is called in the builder call chain.
| int: The number of shots. | ||
|
|
||
| Example: | ||
| >>> task_spec = BraketTaskSpecification(...) # Task specification setup |
There was a problem hiding this comment.
same, you can't ask a user to construct task specification directly
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #976 +/- ##
=======================================
Coverage 89.90% 89.90%
=======================================
Files 110 110
Lines 8131 8131
=======================================
Hits 7310 7310
Misses 821 821 ☔ View full report in Codecov by Sentry. |
There was a problem hiding this comment.
I think in general I think you need to run the emulator to come up with better examples, e.g demonstrate what intermediate result people will get by calling run? what next steps they can do after calling run? I also leave a few more specific comment above. I don't think you should have things like metadata show up in an example that is not very idiomatic.
| task_ir: BraketTaskSpecification | ||
| metadata: Dict[str, ParamType] | ||
| task_result_ir: Optional[QuEraTaskResults] = None | ||
|
|
||
| def _geometry(self) -> Geometry: | ||
| """ |
There was a problem hiding this comment.
This is a private function, and I'm doing duplicated reviews on the same issue. Please work on one of your PRs first before requesting multiple reviews thank you.
Fixes #957