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

AR noise better docstring #100

Merged
merged 4 commits into from
Jul 31, 2024
Merged

AR noise better docstring #100

merged 4 commits into from
Jul 31, 2024

Conversation

behinger
Copy link
Member

No description provided.

@jschepers
Copy link
Collaborator

Thanks for rewriting the doc string. I have two things that could be added:

  • N is the length of the simulated signal in samples, right? I think this is at the moment only implicitly mentioned.
  • Maybe you could write "autoregressive (AR)" instead of only "AR" because there might be users who don't know what the abbreviation stands for.

@jschepers
Copy link
Collaborator

I would suggest merging your changes in the joss-doc-suggestions branch so that all changes related to the JOSS docs review are in the same place. But I don't know whether it's easily possible to change this in the existing PR. But since it's only a small change it might not matter too much.

src/noise.jl Outdated Show resolved Hide resolved
@behinger behinger changed the base branch from main to joss-doc-suggestions July 26, 2024 12:59
src/noise.jl Outdated Show resolved Hide resolved
@behinger
Copy link
Member Author

done :)

src/noise.jl Outdated Show resolved Hide resolved
@jschepers jschepers merged commit aca3fd2 into joss-doc-suggestions Jul 31, 2024
2 checks passed
@jschepers jschepers deleted the behinger-patch-1 branch July 31, 2024 13:05
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.

2 participants