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

documentation has the wrong format for fftsettings #42

Open
tremblap opened this issue Oct 27, 2022 · 5 comments
Open

documentation has the wrong format for fftsettings #42

tremblap opened this issue Oct 27, 2022 · 5 comments

Comments

@tremblap
Copy link
Member

we should either remove the pad options (bad) or add it in the doc (better)

@tremblap
Copy link
Member Author

tremblap commented Jan 7, 2025

and for all maxParameter actually...

@tremblap
Copy link
Member Author

tremblap commented Jan 7, 2025

maybe this should be in the docs repo, @weefuzzy ?

@tremblap
Copy link
Member Author

tremblap commented Jan 7, 2025

(and I disagree with my first comment - I think removing them (as they cannot be dynamic) is probably better. so removing from the doc and removing from the interface as they are redundant.

@weefuzzy
Copy link
Member

weefuzzy commented Jan 8, 2025

When you have time could you flesh out the original issue description a bit? I honestly have no notion what the details refer to, even if I once did.

But, yes, if it's a documentation problem, we should also transfer to docs

@tremblap
Copy link
Member Author

tremblap commented Jan 8, 2025

Sorry, here goes. At the moment, the generated doc has for the maxParam both Param and maxParam

fftsettings and maxfftsize
numcoeffs and maxnumcoeffs
etc

yet the interface is requiring to bundle the max at the end (or a minus one)
1024 -1 -1 -1
13 13

or we get an error.

so what would be amazing:

  • the CLI not to need the max value (taken automagically because they are not dynamic anyway)
  • and
  • the docs to stay as is for the params and to not produce the maxParam in the HTML.

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

2 participants