search

RuleBasedIntegration / Rubi

Rubi for Mathematica
http://rulebasedintegration.org
MIT License
225 stars 22 forks source link

Documentation of Utility Functions #15

Closed halirutan closed 5 years ago

halirutan commented 5 years ago

The file IntegrationUtilityFunctions.m contains many of the condition functions that are used to check whether or not an integration rule can be applied to a particular expression. Many of them lack a usage message, but have a preceding comment that explains what they do. These comments need to be transformed into good usage messages which clearly state what the function checks. Example how it currently looks:

(* If u is a polynomial in v[x], PolynomialInQ[u,v,x] returns True; else it returns False. *)
PolynomialInQ[u_,v_,x_Symbol] := PolynomialInAuxQ[u,NonfreeFactors[NonfreeTerms[v,x],x],x]

Having these comments as ::usage messages for the function allows us to incorporate them into the Steps output so that the user instantly knows what this function does.

AlbertRich commented 5 years ago

Good idea. I transformed all 241 comments in `Integration utility functions.m" into usage messages. The revised file is available at https://github.com/RuleBasedIntegration/RuleBasedIntegration.github.io/tree/master/NotebookRuleFiles