help for examples

Show examples from on-line help files

examples topicname

examples function()

Description

examples looks for help on topicname and displays any
Examples sections found in a Viewer window. Alternatively, examples
looks for help on function() (note the parentheses) and displays a
definition in a Viewer window. It is especially designed to show quick and
easy reminders of the syntax of a given command.

Remarks

Given a topicname, examples looks for sections starting
with titles specified in SMCL containing the word Examples (or
alternatively Example) within any help file corresponding to
topicname. It will not be able to show material from older, pre-SMCL help
files or examples given otherwise.

Examples

. examples regress

. examples reg

. examples normden()

Author

Nicholas J. Cox, Durham University, U.K.

n.j.cox@durham.ac.uk

Acknowledgments

Ken Higbee gave valuable help on aliases. Clive Nicholas pointed
towards a bug. Roger Harbord identified a bug and fixed it. Dick Campbell
pointed out that examples (as was) was broken by Stata 10.

Also see

On-line: help for help; smcl