A message from our CEO about the future of Stack Overflow and Stack Exchange. Read now.

Questions tagged [documentation]

Questions about making your own documentation similar to the built-in documentation style. Also about finding things in the documentation, working with the documentation, errors in the documentation, missing documentation, Context used in the documentation etc.

Filter by
Sorted by
Tagged with
9
votes
1answer
621 views

Methods Available for Derivative Pricing in Mathematica?

I am using Mathematica to price options (built in functions, no need to reinvent the wheel, right?). In the documentation, the Binomial method is used as an example of specifying a non-standard method....
15
votes
2answers
388 views

Pop-up documentation for “The new function of the day”

The Wolfram Language has more than 5000 built-in functions and constants. ...
2
votes
0answers
59 views

Why are CellPrint cells not overwritten?

Quoting https://reference.wolfram.com/language/ref/CellPrint.html Cells generated by `CellPrint` by default have `GeneratedCell->True`, so that they are overwritten if they are regenerated. An ...
1
vote
0answers
266 views

Two issues about Underline(d)

From the Help Browser Style["abcd xyz", FontVariations -> {"Underline" -> True}] abcd xyz The text is NOT Underlined, contrary to the online version Also ...
7
votes
0answers
212 views

Monitor function doesn't show continious change of values

Bug introduced in 10.0 and fixed in 11.0.0 Mathematica version: 10.2 Monitor[i = 0; While[i < 100, Pause[0.1]; i++]; i, i] The above code is from the ...
10
votes
1answer
228 views

DSolve documention on web differs greatly from distributed MMA 10.2.0 version

In the course of improving my answer to 95361, I noticed that the DSolve documentation on the web is much better written than that distributed with Mathematica 10.2....
9
votes
3answers
260 views

How to create a documentation page for a given message issued by a (user-defined) function?

I want to create properly linked documentation pages dedicated to specific messages issued by my own functions inside a package, similar to those for messages of built-in functions like ...
4
votes
0answers
163 views

errors in CUDA example

It seems that there are some errors in the documentation page Consider these functions in the documentation CUDA Programming. However, I'm not a expert in CUDA nor C, could you check whether these are ...
9
votes
1answer
134 views

ImageAdjust Documentation issues

Bug in ImageAdjust introduced in 8.0.4 or earlier and fixed in 11.0 Documentation bug for ImageAdjust introduced in 8 or ...
14
votes
1answer
434 views

“ParametricSensitivity” in ParametricNDSolve

"ParametricSensitivity" is listed as a Method in the documentation for ParametricNDSolve, ...
11
votes
2answers
148 views

A possible bug about WordCharacter on CJK characters

According to the documentation of WordCharacter: WordCharacter matches any character for which either ...
20
votes
1answer
292 views

New AssociationThread forms in 10.2?

Bug introduced in 10.2.0 and fixed in 10.3.0 (The extension of AssociationThread is not (yet) implemented and the corresponding documentation has been removed) ...
18
votes
1answer
411 views

A With expression local variable specification without head List

I just noticed a new form of With in its documentation: With[$x=x_0$, $expr$] specifies that all occurrences of the symbol $x$ in $expr$ should be replaced ...
2
votes
0answers
74 views

Documentation on the attribute OneIdentity [duplicate]

The documentation on the attribute OneIdentity says OneIdentity is an attribute that can be assigned to a symbol f to ...
4
votes
1answer
419 views

Where can I access documentation for old versions of Mathematica?

Some documentation of functions available in old versions of Mathematica (and old packages) is available online, e.g. http://reference.wolfram.com/language/Combinatorica/ref/Vertices.html Is there ...
13
votes
2answers
808 views

Is FrameTicks broken in 10.1.0?

On my system, Mathematica 10.1.0 under Windows, none of these FrameTicks documentation examples work correctly: ...
2
votes
1answer
231 views

Using PlotRange to cut off outlying points

In the documentation for PlotRange, there is the following line: If a particular minimum or maximum is specified as {Automatic, α}, this means that the range ...
17
votes
2answers
259 views

How do I add my own help pages to the in-built Wolfram documentation?

How do I add my own help pages to the in-built Wolfram documentation ?
1
vote
1answer
74 views

What am I missing on this part of the documentation?

In the documentation for FullSimplify, under Options > Assumptions it is stated that: When assumptions are given as an argument, $Assumptions is used as well: ...
5
votes
3answers
203 views

Why does TreePlot ignore the vertex labels in a TreeGraph argument?

Example (watch the vertex labels): aTree = TreeGraph[{"a" -> "b", "a" -> "c"}, VertexLabels -> "Name"] ...
13
votes
3answers
1k views

What does the AspectRatio option actually do?

The Documentation for AspectRatio on its first line under the "Details" section states: "AspectRatio determines the scaling for ...
22
votes
0answers
394 views

Documentation of the frequently-used functions in the context of Internal` and Compile` [duplicate]

In this site, I have gradually found out that there is a collection of functions in all kinds of answers. For instance, Compile`GetElement, ...
8
votes
1answer
600 views

Is It Safe to Remove the Documentation Notebooks?

I am running Mathematica 10 on linux and noted that the directories containing Mathematica's documentation come to over 3GB. Am I safe to delete these directories without affecting how Mathematica ...
4
votes
1answer
92 views

? (Definition) versus ?? (Information)

What is the difference between ? Definition and ?? ...
8
votes
2answers
164 views

FindDivisions behavior changed?

Bug introduced in 8.0.4 or sooner and fixed in 10.4.1 I seem to recall using FindDivisions as a quick way to get all numbers in an interval that are divisible by a ...
17
votes
2answers
463 views

Inline documentation of “Properties”

Context I find the documentation has become a bit of a maze, in particular given the more recent convention of having keywords has strings rather than Mathematica Keywords. For instance, ...
3
votes
1answer
101 views

Should local Documentation match reference.wolfram.com?

I've searched here for similar questions but was unable to find any. I have a specific example where my local documentation does not match the documentation on http://reference.wolfram.com/language/ (...
4
votes
1answer
96 views

Evaluating documentation example crashes the kernel

Save your work before attempting: Could someone confirm what looks like a bug (definitely occurs in v10 and OSX 10.8.5): In the documentation for Background and ...
9
votes
1answer
224 views

What really makes a Dialog window behave as a modal dialog?

CreateDialog[DefaultButton[], Modal -> True] creates a modal Dialog, one which needs to be closed before the front-end ...
13
votes
1answer
455 views

How to use Get on a folder

Documentation flaw introduced before 9.0 and persisting through V11.0.0 In the documentation for Get it says: If the file found by ...
4
votes
1answer
129 views

Is the use of StringTemplate with a styled string documented behavior?

I was pleasantly surprised to find out that StringTemplate appears to work with styled (formatted) strings, with the style of the slots applied to the inserted ...
9
votes
0answers
152 views

Is there a documentation generator for Mathematica?

I'm looking for a way to document the functions of my packages inline, preferably inside comments. There should be a Doxygen type tool for this that takes comments and that generates html from markup ...
4
votes
1answer
262 views

Mathematica as Answer Set Programming (ASP) engine?

Maybe I need to rephrase this question, so that it might receive some attention: Are there any packages or examples of how to put Mathematica to good use in the field of ASP (Answer Set Programming) ...
1
vote
0answers
84 views

Purpose of VertexWeight

I am trying to partition a graph into partitions of equal weight (on the vertex). I looked at the documentation, and found VertexWeight, which seems to attach a weight to a vertex. In the details, ...
10
votes
1answer
328 views

How do I efficiently navigate the Documentation Center?

Back in the day, I read the Mathematica Book cover-to-cover, and I found it to be an enlightening experience. I realize that the Documentation Center is now an order of magnitude larger than the ...
28
votes
2answers
869 views

Default behaviour of Hash[expr] and hashing in different versions of Mathematica

In different versions of Mathematica, Wolfram silently changed the behaviour of Hash when the algorithm is not specified explicitly ...
8
votes
1answer
344 views

Fixing links to symbol pages with special characters made with Workbench

I am writing documentation for a package using Workbench v2.0 and Mathematica v9.0.1, and certain Symbols defined by my package have special (Greek) characters characters e.g. ...
4
votes
1answer
101 views

Missing links in usage statements

The integration of the documentation center does not seem to be complete on my machine. I often access the documentation center via the usage statement links. ?Sin ...
6
votes
1answer
164 views

What can I do with “Syntax Templates” section at start of Symbol Pages (in Workbench)?

At the top of each Symbol Page, there are a bunch of little sections in grey (see screen shot). But I do not understand how to use them. I am particularly interested in the "Syntax templates" ...
6
votes
1answer
335 views

Documentation with Workbench: Paclet vs Package

I am writing documentation for my package in Workbench v2.0 with Mathematica v9.0.1. But for some reason, all of the help pages (and the index) of the package say that the various functions and ...
7
votes
1answer
357 views

Merging documentation from Workbench with package coded outside Workbench

On the one hand, I have been writing my package (directly into the .m file) separately using the standard Mathematica front-end. My source .m files and the init.m files have the appropriate folder ...
36
votes
1answer
1k views

How to extract a list of available Method-s

The option Methodapplies for several functions, such as NDSolve, FindRoot, ...
5
votes
1answer
96 views

Code/Exp Search Documentation Center Mathematica

I have added several of my own applications to my Mathematica documentation center. Currently Mathematica uses followings notebook options to help the user search for specific functions. ...
16
votes
2answers
310 views

Listable functions thread over Associations; is this documented?

Thanks to a somewhat misapplied use of MapThread I learned of this behavior: ...
3
votes
2answers
250 views

How can I change the default font size of the Virtual Book?

How can I change the default font size of the Virtual Book?
5
votes
2answers
223 views

Non sequitur in documentation of MemberQ

Mr.Wizard's question about MemberQ and FreeQ got me to re-read the documentation for those functions. I find I don't understand ...
8
votes
3answers
312 views

Problem with Classify Documentation Center page

Bug introduced in 10.0 and fixed in 10.2 Every time I try to open the "Neat Examples" tab on the documentation center page for the function Classify Mma gets stuck ...
17
votes
2answers
226 views

Bug in Operator Form of StringCases

fixed in 10.1 (windows) According to the documentation there's an operator form for StringCases ?StringCases Here is the ...
4
votes
1answer
167 views

Get Documentation Search Results Programmatically

Currently I don't have access to Wolfram Workbench but would like to add my own pages to the documentation search results in Mathematica. How might I most easily manually add pages to the ...
24
votes
1answer
567 views

A documented syntax of FileNames doesn't work?

Documentation discrepancy present in 10.3 and fixed in 10.4.1 According to the documentation for FileNames under Details: However when I attempt to use this ...