Skip to main content

version 10 - What is the status of `::usage` and Templates in Mathematica v11?


Since Mathematica 9, a number of issues concerning the ::usage and templates were raised.


In 9.0, there was a bug first reported here and better diagnosed here, where error messages were generated by simply moving the insertion point somewhere in the argument of a function for which a ::usage was defined. This was fixed in 9.0.1


Starting in version 9.0 and observed through 10.4.1, it was reported here that functions with formatted ::usage needed ?Function to be called twice in order for messages to be rendered properly. A bandaid solution was given here.


Certain inflexibility about the text in the templates was raised here and again here, and inconsistencies reported here (also see here).


The consensus I gather from the discussion in the comments above is that ::usage and templates are implemented in Mathematica in a very kludgy way. This can be a source of major frustration for package developers.


So the question I raise is which of the issues have been addressed in v10 and v11? Are there plans for a major overhaul of the ::usage system?



Answer



1) The complete failure of Make Template with formatted usages is fixed in our next release. I can't promise you it will look 100% beautiful in all cases, but the number of templates will match the number in the usage message and you'll at least recognize it as something related to what you put in there. I'm sorry it's taken so long to be addressed--it really has been on our radar for some time--but the fix required a certain amount of cleanup that was not easy to do.



2) About the need to call information twice, we didn't fix it because it was never reported as a bug. There were a few internal reports, but nothing external. We can't fix what we don't know about. While we do monitor stack exchange, there is no substitute for actual bug reports send to support. This has the greatest chance of being routed to the right developer, and the more people how report it, the more resources might be spent on fixing the issue. I'll respond with more details on the appropriate question, but this issue is also fixed for the next release.


3) It's true that we don't provide the same capabability for developer templates as our own. For many reasons, our internal tooling has been constantly evolving since V9 came out. Deploying it to external developers, when we are not confident it is robust and stable, just hasn't been feasible. Hopefully we will get there, but we're certainly not in a position to promise on any particular schedule. In the mean time, we've dealt with two significant issues in our upcoming release. If there are more point fixes we can make to the current system, send in reports!


Comments

Post a Comment

Popular posts from this blog

plotting - How to draw lines between specified dots on ListPlot?

I would like to create a plot where I have unconnected dots and some connected. So far, I have figured out how to draw the dots. My code is the following: ListPlot[{{1, 1}, {2, 2}, {3, 3}, {4, 4}, {1, 4}, {2, 5}, {3, 6}, {4, 7}, {1, 7}, {2, 8}, {3, 9}, {4, 10}, {1, 10}, {2, 11}, {3, 12}, {4,13}, {2.5, 7}}, Ticks -> {{1, 2, 3, 4}, None}, AxesStyle -> Thin, TicksStyle -> Directive[Black, Bold, 12], Mesh -> Full] I have thought using ListLinePlot command, but I don't know how to specify to the command to draw only selected lines between the dots. Do have any suggestions/hints on how to do that? Thank you. Answer One possibility would be to use Epilog with Line : ListPlot[ {{1, 1}, {2, 2}, {3, 3}, {4, 4}, {1, 4}, {2, 5}, {3, 6}, {4, 7}, {1, 7}, {2, 8}, {3, 9}, {4, 10}, {1, 10}, {2, 11}, {3, 12}, {4, 13}, {2.5, 7}}, Ticks -> {{1, 2, 3, 4}, None}, AxesStyle -> Thin, TicksStyle -> Directive[Black, Bold, 12], Mesh -> Full, Epilog -> { Line[ ...
Post a Comment
Read more

equation solving - Invert and fit implicitly defined curve

I need to fit an implicitly defined curve. I thought I could get some data out of Solve , and then using FindFit . Therefore, I would like to find the relation the parametric curve defined by $F(x,y)=0$: Solve[-(1/2) + 1/2 (0.41202 BesselK[0, 0.1 Sqrt[x^2 + y^2]] + (0.101483 x BesselK[1, 0.1 Sqrt[x^2 + y^2]])/Sqrt[x^2 + y^2]) == 0, y] But I can't get an output: Solve was unable to solve the system with inexact coefficients or the system obtained by direct rationalization of inexact numbers present in the system. Since many of the methods used by Solve require exact input, providing Solve with an exact version of the system may help. >> Edit: In particular, I would like to fit the data coming from the curve with the expression of another curve, and not with a function $f(x)$. In particular, since this clearly looks like a cardioid , I would like it to fit to something like it. What other strategies could I try?
Post a Comment
Read more

dynamic - How can I make a clickable ArrayPlot that returns input?

I would like to create a dynamic ArrayPlot so that the rectangles, when clicked, provide the input. Can I use ArrayPlot for this? Or is there something else I should have to use? Answer ArrayPlot is much more than just a simple array like Grid : it represents a ranged 2D dataset, and its visualization can be finetuned by options like DataReversed and DataRange . These features make it quite complicated to reproduce the same layout and order with Grid . Here I offer AnnotatedArrayPlot which comes in handy when your dataset is more than just a flat 2D array. The dynamic interface allows highlighting individual cells and possibly interacting with them. AnnotatedArrayPlot works the same way as ArrayPlot and accepts the same options plus Enabled , HighlightCoordinates , HighlightStyle and HighlightElementFunction . data = {{Missing["HasSomeMoreData"], GrayLevel[ 1], {RGBColor[0, 1, 1], RGBColor[0, 0, 1], GrayLevel[1]}, RGBColor[0, 1, 0]}, {GrayLevel[0], GrayLevel...
Post a Comment
Read more