Merged
Conversation
Documentation fixes: - Fix corrupted docstring in nbinit.py (code accidentally pasted into text) - Fix anonymous hyperlink warning in DataProv-MSDefender.rst (missing space) - Rewrite prismacloud_driver.py docstrings to use standard NumPy format - Remove non-standard 'Behavior' and 'Logging' sections - Convert bullet lists to inline format for kwargs descriptions - Reorder sections: Parameters -> Returns -> Raises -> Example - Add API docs for new openobserve_driver module Code fixes: - Rename MordorEntry.type to entry_type to avoid shadowing builtin - Update mordor_driver.py to map YAML 'type' field to 'entry_type' - Fix test_mordor_driver.py to handle the type->entry_type rename Type annotation modernization: - Add 'from __future__ import annotations' to ~20 visualization modules - Add helper script tools/add_future_annotations.py for future use These changes reduce Sphinx build warnings from 219 to 146.
Contributor
Author
|
This a massive PR with very little substantial code changes - it is primarily about removing old deprecated API docs and adding newly added ones. All other changes are related to updating sphinx and getting clean sphinx (read-the-docs) build |
FlorianBracq
approved these changes
Jan 21, 2026
…//github.com/microsoft/msticpy into ianhelle/documentation_updates_v3-2026-01-21
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Generated new API files for v3.0 codebase
from __future__ import annotationsto many modules. This has the side benefit of letting a lot of the code run on earlier version.Documentation fixes:
Code fixes:
Type annotation modernization:
These changes reduce Sphinx build warnings from 219 to 146.