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

Refactor documentation and resolve module visibility issues in PyKale #386

Merged
merged 3 commits into from
Jun 15, 2023

Conversation

SinaTabakhi
Copy link
Member

Description

The PyKale documentation currently lacks documentation for a few modules, and there are issues where the body of certain modules is not visible (as shown in the provided image). To address these concerns, it is necessary to update the PyKale documentation by adding the missing modules, fixing errors that prevent modules from being displayed, and reordering the modules to ensure an alphabetically-sorted arrangement. This update will improve the PyKale documentation.

image

Status

Ready

Types of changes

  • Non-breaking change (fix or new feature that would not break existing functionality).
  • Breaking change (fix or new feature that would cause existing functionality to change).
  • New tests added to cover the changes.
  • In-line docstrings updated.
  • Source for documentation at docs manually updated for new API.

@SinaTabakhi SinaTabakhi added the refactor Refactor of existing code label Jun 14, 2023
@SinaTabakhi SinaTabakhi self-assigned this Jun 14, 2023
@codecov-commenter
Copy link

codecov-commenter commented Jun 14, 2023

Codecov Report

Merging #386 (40edb43) into main (607c3cc) will not change coverage.
The diff coverage is n/a.

❗ Your organization is not using the GitHub App Integration. As a result you may experience degraded service beginning May 15th. Please install the Github App Integration for your organization. Read more.

@@           Coverage Diff           @@
##             main     #386   +/-   ##
=======================================
  Coverage   91.51%   91.51%           
=======================================
  Files          49       49           
  Lines        5234     5234           
=======================================
  Hits         4790     4790           
  Misses        444      444           

Copy link
Member

@haipinglu haipinglu left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Excellent 💪. Thank you.

@haipinglu haipinglu enabled auto-merge June 15, 2023 06:44
@haipinglu haipinglu merged commit cfab9b8 into pykale:main Jun 15, 2023
8 checks passed
This was referenced Jul 13, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
refactor Refactor of existing code
Projects
Status: Done
Development

Successfully merging this pull request may close these issues.

None yet

3 participants