Skip to content

Commit fc47fc5

Browse files
committed
documentation updated
1 parent 718ba78 commit fc47fc5

File tree

2 files changed

+8
-22
lines changed

2 files changed

+8
-22
lines changed

README.md

Lines changed: 6 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ This SDK enables Dynatrace customers to extend request level visibility into Pyt
2121
* [Incoming web requests](#incoming-web-requests)
2222
* [Outgoing web requests](#outgoing-web-requests)
2323
* [Trace in-process asynchronous execution](#trace-in-process-asynchronous-execution)
24-
* [Custom Request Attributes](#custom-request-attributes)
24+
* [Custom request attributes](#custom-request-attributes)
2525
- [Troubleshooting](#troubleshooting)
2626
* [Installation issues](#installation-issues)
2727
* [Post-installation issues](#post-installation-issues)
@@ -148,7 +148,9 @@ Unusual events that prevent an operation from completing successfully include:
148148
* API usage errors
149149
* other unexpected events (like out of memory situations)
150150

151-
The exact situations and arguments in/with which the callback is invoked are undocumented and may change at any time.
151+
> *NOTE*: Use this as a development and debugging aid only. Your application should not rely on a calling sequence or any arguments in addition to the
152+
unicode message being set or passed to the callback.
153+
152154
```python
153155
def _diag_callback(unicode_message):
154156
print(unicode_message)
@@ -281,7 +283,7 @@ See the documentation for more information:
281283
<a name="incoming-web-requests"></a>
282284
### Incoming web requests
283285

284-
[Like for database infos](#sql-database-requests), to trace incoming web requests you need a web application info object which stores the
286+
[Same as with database infos](#sql-database-requests), to trace incoming web requests you need a web application info object which stores the
285287
information about your web application which does not change:
286288

287289
```python
@@ -512,7 +514,7 @@ If you are viewing the [GitHub repository](https://github.com/Dynatrace/OneAgent
512514
<a name="let-us-help-you"></a>
513515
### Let us help you
514516

515-
Make sure your issue is not already solved in the [available documentation](#documenation) before you ask for help. Especially the
517+
Make sure your issue is not already solved in the [available documentation](#documentation) before you ask for help. Especially the
516518
[troubleshooting section in this README](#troubleshooting) may prove helpful.
517519

518520

@@ -530,21 +532,6 @@ Make sure your issue is not already solved in the [available documentation](#doc
530532
Please see the [GitHub releases page](https://github.com/Dynatrace/OneAgent-SDK-for-Python/releases),
531533
and the [PyPI release history](https://pypi.org/project/oneagent-sdk/#history).
532534

533-
### Breaking Changes in 1.1.0
534-
The SDK initialization has changed. Until now you had the possibility to initialize the SDK using
535-
two methods:
536-
- `oneagent.try_init()`
537-
- `oneagent.sdk.SDK.get()`
538-
539-
The latter method implicitly initialized the SDK. This was changed in 1.1.0. Both methods were removed.
540-
Now it's mandatory to call [`oneagent.initialize()`](https://dynatrace.github.io/OneAgent-SDK-for-Python/docs/sdkref.html#oneagent.initialize)
541-
to initialize the SDK and [`oneagent.shutdown()`](https://dynatrace.github.io/OneAgent-SDK-for-Python/docs/sdkref.html#oneagent.shutdown)
542-
to shut the SDK down. For each initialize call there must be a corresponding shutdown call. The
543-
`oneagent.sdk.SDK.get()` method was replaced by a new [`oneagent.get_sdk()`](https://dynatrace.github.io/OneAgent-SDK-for-Python/docs/sdkref.html#oneagent.get_sdk)
544-
method which does not implicitly initialize the SDK anymore. If this new method is called without
545-
previously initializing the SDK then a dummy (non-functional) SDK instance will be returned. This
546-
instance won't do anything if it is used later.
547-
548535

549536
<a name="license"></a>
550537
## License

src/oneagent/sdk/__init__.py

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -377,9 +377,8 @@ def set_diagnostic_callback(self, callback):
377377
- Other unexpected events (like out of memory situations) that prevented
378378
an operation from completing successfully.
379379
380-
Use this as a development and debugging aid only. The exact situations
381-
and arguments in/with which the callback is invoked are undocumented and
382-
may change any time.
380+
.. warning:: Use this as a development and debugging aid only. Your application should not
381+
rely on a calling sequence or any arguments being set or passed to the callback.
383382
384383
:param callable callback: The callback function. Receives the (unicode)
385384
error message as its only argument.

0 commit comments

Comments
 (0)