Menu

Outdated documentation on shape, referring to non-existent files?

Help
We Rame
2022-01-14
2022-01-14
  • We Rame

    We Rame - 2022-01-14

    The manual page says

    (shape signal table origin) [LISP]
    [....] Further discussion and examples can be found in nyquist/lib/distortion/distortion.html. The shape function is also used to map frequency to amplitude to achieve a spectral envelope for Shepard tones in nyquist/lib/shepard/shepard.lsp.

    However I can't locate either of those files (distortion.html, shepard.lsp) in the latest 3.17 source distribution.

    I tried to post this as a ticket, instead of discussion, but SouceForge won't let me, by the way.

     
  • We Rame

    We Rame - 2022-01-14

    By the way, there are a bunch more files that refer to that non-existent shepard demo:

    nyquist/demos/index.htm:148:      <dt><b>shepard</b><br></dt>
    nyquist/demos/index.htm:151:        There is also a <tt>shepard/shepard.ny</tt> Shepard tone plug-in
    nyquist/doc/guide.html:816:<a href="part8.html#index464" target=m>Demos, shepard tones</a><br>
    nyquist/doc/indx.html:451:<a href="part8.html#index464">Demos, shepard tones</a><br>
    nyquist/doc/part2.html:636:<li>Shepard tones (<code>nyquist/lib/shepard/shepard.lsp</code> and
    nyquist/doc/part8.html:1264:Shepard tones in <code>nyquist/lib/shepard/shepard.lsp</code>.<a name="index463"></a><a name="index464"></a><br><br>
    nyquist/docsrc/bib/music.bib:2680:@article(shepardspiral
    nyquist/docsrc/nyquist/nyquistman-sal-only.mss:766:Shepard tones (@code(demos/shepard.lsp) and @code(demos/pmorales/b9.lsp))@index(Shepard tones)@index(endless tones)
    nyquist/docsrc/nyquist/nyquistman-sal-only.mss:3855:Shepard tones in @code(demos/shepard.lsp).@index(Shepard tones)@index(demos, Shepard tones)
    nyquist/docsrc/nyquist/nyquistman.mss:998:Shepard tones (@code(nyquist/lib/shepard/shepard.lsp) and
    nyquist/docsrc/nyquist/nyquistman.mss:4624:Shepard tones in @code(nyquist/lib/shepard/shepard.lsp).@index(Shepard tones)@index(demos, Shepard tones)
    nyquist/files.txt:86:a demos/shepard.lsp
    nyquist/files.txt:87:a demos/shepard.ny
    nyquist/lib/examples.sal:655:    load "shepard/shepard.lsp"
    nyquist/todo.txt:142:x    shepard tones
    

    The index.htm also assures us the file exists:

    shepard
    is a Lisp source file that produces Shepard tones. See comments in the code for explanations and documentation. There is also a shepard/shepard.ny Shepard tone plug-in for Audacity.

    But it doesn't exist. Perhaps you forgot to commit it to the repo?

    Also, the entire pmorales and mateos subdirs in demos are empty, even though index.htm describes what should have been in there. So, I'm getting the impression that you've moved out most of the demos (perhaps to a different repo or site) at one point... but index.htm stayed behind.

    A bit more googling found a 7-years old github clone/repo that has all of those, e.g.
    distortion.htm (https), the pmorales examples and the shepard.lsp (github.com). I haven't tried to see if they work with the current Nyquist.

     

    Last edit: We Rame 2022-01-14
  • Roger B. Dannenberg

    I think I disabled tickets because they sometimes appeared and went unnoticed. Better to send email to me directly.

    A lot of code was moved to the relatively new "Extensions Manager" in NyquistIDE, which lets you pick and install extensions, which become subdirectories of nyquist/lib. The source is in nyquist/extensions.

    I updated the source for the documentation you mentioned for the next release. Some other extensions, e.g. pvoc explicitly state you should install the extension, but obviously I didn't catch all the references in the documentation when I moved code out of nyquist/lib.

    I think I tried to get rid of those empty directories in lib on SVN. I vaguely remember something about empty directories and SVN, and I'm not sure how to get rid of them. They seemed harmless, but maybe not.

     

Log in to post a comment.

MongoDB Logo MongoDB