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

a few places where help and manual are out of sync #16303

Closed
JeffBezanson opened this issue May 10, 2016 · 8 comments
Closed

a few places where help and manual are out of sync #16303

JeffBezanson opened this issue May 10, 2016 · 8 comments
Assignees
Labels
docs This change adds or pertains to documentation
Milestone

Comments

@JeffBezanson
Copy link
Member

Here are some examples. @threadcall has a docstring and ? works at the command line, but the macro doesn't seem to appear anywhere in the manual. Going the other way, exported constants like OS_NAME appear in the manual but ?OS_NAME says no documentation is found.

@JeffBezanson JeffBezanson added the docs This change adds or pertains to documentation label May 10, 2016
@tkelman
Copy link
Contributor

tkelman commented May 11, 2016

ref #14264 (comment)

@kshyatt
Copy link
Contributor

kshyatt commented Aug 2, 2016

OS_NAME is deprecated now, but @threadcall still isn't in the manual afaict.

@vtjnash
Copy link
Member

vtjnash commented Aug 2, 2016

afaik, @threadcall is not in the manual because it is unsupported

@kshyatt
Copy link
Contributor

kshyatt commented Aug 2, 2016

Ok, will close this then. Reopen if needed.

@kshyatt kshyatt closed this as completed Aug 2, 2016
@tkelman
Copy link
Contributor

tkelman commented Aug 2, 2016

If it's unsupported we shouldn't have it at all. It's exported, so it should be documented. Or we should deprecate it.

@tkelman tkelman reopened this Aug 2, 2016
@vtjnash
Copy link
Member

vtjnash commented Aug 2, 2016

I think that's @StefanKarpinski's call, since he wrote the implementation

@amitmurthy
Copy link
Contributor

Mark it as experimental and document it?

@StefanKarpinski
Copy link
Member

@amitmurthy's suggestion seems like the soundest one. Marking as 0.5.x.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs This change adds or pertains to documentation
Projects
None yet
Development

No branches or pull requests

6 participants