Major improvements in documentation #26
Merged
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.
Improved documentation and structure for pydbsmgr package
Description:
This pull request aims to enhance the overall quality and usability of the pydbsmgr package by refining its documentation and structure.
Details:
README
file: A rewritten introduction that provides a clear overview of the package's features, modules, and usage.pydbsmgr.main
,pydbsmgr.utils.azure_sdk
, andpydbsmgr.utils.tools
) to help users better understand their functionality and how they can be used together.These improvements will make pydbsmgr a more welcoming and intuitive experience for new users, while also helping existing contributors to better understand the package's inner workings.