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

Add Documentation #7

Closed
9 tasks done
Firionus opened this issue Apr 4, 2022 · 0 comments
Closed
9 tasks done

Add Documentation #7

Firionus opened this issue Apr 4, 2022 · 0 comments

Comments

@Firionus
Copy link
Owner

Firionus commented Apr 4, 2022

Some suggested content:

  • API Docs
  • Document return values of functions. Follow this template: https://discourse.julialang.org/t/coordinating-community-efforts-to-enrich-function-docs/80338/45
  • There should be a diagram and concise explanation of the resampling approach in the README.
    • Create Diagram Code
    • Set Up Documenter and README Documentation
    • Is Doctest run?
    • Document an Example in the docstring where all args are used
    • Document how to construct and call your own window functions
  • Diagrams and Explanations of the different windows and their parameters

Examples, e.g. frequency response measurements -> do that in smoothing library

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

No branches or pull requests

1 participant