Skip to content

Conversation

@felixblanke
Copy link
Collaborator

@felixblanke felixblanke commented Jun 27, 2024

This PR bundles work to improve the documentation throughout the code base.

  • Split the API reference into multiple pages
  • Add explanation of boundary handling / signal extensions
  • Add documentation of padding mode
  • Add documentation of compatible wavelet objects
  • Extend usage examples
  • Add contribution page
  • Potentially: Introduce release notes?

Further, I would like to go through all modules to check the docstrings for consistency:

  • constants.py
  • continuous_transform.py
  • conv_transform_2.py
  • conv_transform_3.py
  • conv_transform.py
  • __init__.py
  • matmul_transform_2.py
  • matmul_transform_3.py
  • matmul_transform.py
  • packets.py
  • separable_conv_transform.py
  • sparse_math.py
  • stationary_transform.py
  • _util.py
  • version.py
  • wavelets_learnable.py
@felixblanke felixblanke added the documentation Improvements or additions to documentation label Jun 27, 2024
@felixblanke felixblanke self-assigned this Jun 27, 2024
@v0lta
Copy link
Owner

v0lta commented Jun 28, 2024

We have some release notes at https://github.com/v0lta/PyTorch-Wavelet-Toolbox/releases. We could include a link to those in the docs.

@v0lta v0lta marked this pull request as ready for review February 14, 2025 09:32
@v0lta
Copy link
Owner

v0lta commented Feb 14, 2025

Having these nice improvements dangling here in the PR makes no sense. I will merge these improvements and open an issue to ensure we don't forget the other improvement ideas.

@v0lta
Copy link
Owner

v0lta commented Feb 14, 2025

Okay, it's not that simple, but I think I am getting there.

@v0lta v0lta merged commit c54f9dd into main Feb 14, 2025
7 checks passed
@v0lta v0lta deleted the improve-docs branch February 14, 2025 16:26
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

3 participants