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

Include links to online doc in help text of single functions #120

Open
hagenw opened this issue Dec 7, 2016 · 0 comments
Open

Include links to online doc in help text of single functions #120

hagenw opened this issue Dec 7, 2016 · 0 comments
Assignees

Comments

@hagenw
Copy link
Member

hagenw commented Dec 7, 2016

It might be a good idea to include links to corresponding sections in the online documentation at the end of the header comments of single functions.

The problem is that most of the links are longer than 80 characters and fit not very well into the help text.
For example:

http://matlab.sfstoolbox.org/en/latest/binaural-simulations/#frequency-response-of-your-spatial-audio-system

Before including the links it would be nice to find a good way to shorten them.

@hagenw hagenw self-assigned this Dec 7, 2016
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

1 participant