Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Major improvements in documentation #26

Merged
merged 1 commit into from
Jul 3, 2024
Merged

Major improvements in documentation #26

merged 1 commit into from
Jul 3, 2024

Conversation

jzsmoreno
Copy link
Owner

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:

  • Improved README file: A rewritten introduction that provides a clear overview of the package's features, modules, and usage.
  • Enhanced module descriptions: Detailed explanations for each main module (pydbsmgr.main, pydbsmgr.utils.azure_sdk, and pydbsmgr.utils.tools) to help users better understand their functionality and how they can be used together.
  • Reorganized directory structure: A more logical and consistent folder hierarchy that makes it easier to navigate the package's contents.
  • Updated code comments: Additional inline documentation throughout the codebase, providing context for specific functions, classes, and variables.

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.

@jzsmoreno jzsmoreno merged commit 480e6ab into main Jul 3, 2024
2 checks passed
@jzsmoreno jzsmoreno deleted the develop branch July 3, 2024 07:10
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant