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

"warnings generated" output doesn't match idldoc-warnings.html #37

Closed
mgalloy opened this issue Oct 22, 2012 · 3 comments
Closed

"warnings generated" output doesn't match idldoc-warnings.html #37

mgalloy opened this issue Oct 22, 2012 · 3 comments

Comments

@mgalloy
Copy link
Owner

mgalloy commented Oct 22, 2012

It's not clear how idldoc "warnings" are defined. I can execute idldoc on a set of routines and the IDL output log window will say "0 warnings generated". However, in the idldoc-warnings.html file that's created, I may have a number of files listed with partial or no documentation. I use the latter file quite a bit to make sure my comments are consistent with my code. Maybe there needs ot be a separate category name for items that are warnings of a different type. It'd also be nice if there was more detail when documentation is only partial, for example, "missing keyword description" or "missing return value description". Those are the two most common I run across.

@ghost ghost assigned mgalloy Oct 22, 2012
@mgalloy mgalloy closed this as completed Oct 22, 2012
@mgalloy
Copy link
Owner Author

mgalloy commented Oct 22, 2012

This is an error in labeling: the "warnings" that IDL print in the output log are basically syntax errors in your documentation syntax, the "warnings" on the idldoc-warnings.html page are incomplete documentation. Maybe the idldoc-warnings.html page could be labeled "Incomplete documentation warnings"?

Yes, I've thought about adding more detail to the partial documentation listing. It will just be a bit of a pain.

@mgalloy
Copy link
Owner Author

mgalloy commented Oct 22, 2012

Well, on second thought, how about adding another category on the idldoc-warnings.html page that is "Syntax errors"?

@mgalloy
Copy link
Owner Author

mgalloy commented Oct 22, 2012

This is ticket #8 already. The suggestion there is to make a "Runtime warnings" section, but the same idea.

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