MATLAB documentation overwriting built-in function!

N.B.: Didn't know where to put this, it's not a question but rather a "heads up", and since it's not a "bug" per se I didn't want to put it in "Bug reports". Anyway, I just stumbled upon this piece of documentation, where a built-in function is overwritten in the example: Documentation link: inputdlg The built-in function 'title' is overwritten in more than one of the following examples in the documentation:
Example in documentation:
prompt = {'Enter matrix size:','Enter colormap name:'};
title = 'Input';
dims = [1 35];
definput = {'20','hsv'};
answer = inputdlg(prompt,title,dims,definput)
Since "title" is already a built-in function use of the examples, in the documentation, gave rise to some issues that was quickly discovered, however, I think it's a bad example to have. Anyhow, just wanted to let you know (whoever fixes these things) :)
Best regards!

4 Kommentare

Adam
Adam am 11 Sep. 2018
Bearbeitet: Adam am 11 Sep. 2018
Use the 'Was this topic helpful?' link at the bottom of a help page and you then get the option to fill in forms of additional information. I have done this a few times to report issues with the help.
I can't remember if you still get the questions if you select 'Yes', but certainly you do if you select 'No' and since you do get to add comments those reading it will quickly understand the problem so you needn't worry (as I did the first time I tried it) that it seems as though you are just saying the whole help page is unhelpful.
Please submit a service request for technical support. "Documentation errors" is one of the categories. I've done it before. I think the technical writer would appreciate your help in improving its documentation.
Guillaume
Guillaume am 11 Sep. 2018
Yes, raising a service request for documentation errors is very useful. And usually, you get informed when it's fixed (which is not necessarily the next version).
Thanks for the feedback everyone. I've submitted a service request for technical support and documentation errors. :)

Melden Sie sich an, um zu kommentieren.

 Akzeptierte Antwort

Alexander Jensen
Alexander Jensen am 11 Sep. 2018

0 Stimmen

"Answer" to the proper way to report a documentation error:
Contact Us -> Contact Support -> Service Request -> Documentation Errors, etc.

Weitere Antworten (0)

Kategorien

Produkte

Version

R2018a

Community Treasure Hunt

Find the treasures in MATLAB Central and discover how the community can help you!

Start Hunting!

Translated by