<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
<!-- This manual is for GNU Texinfo (version 6.7, 23 September 2019),
a documentation system that can produce both online information and a
printed manual from a single source using semantic markup.
Copyright (C) 1988, 1990, 1991, 1992, 1993, 1995, 1996, 1997,
1998, 1999, 2001, 2001, 2003, 2004, 2005, 2006, 2007, 2008, 2009,
2010, 2011, 2012, 2013, 2014, 2015, 2016, 2017, 2018, 2019 Free Software
Foundation, Inc.
Permission is granted to copy, distribute and/or modify this document
under the terms of the GNU Free Documentation License, Version 1.3 or
any later version published by the Free Software Foundation; with no
Invariant Sections, with no Front-Cover Texts, and with no Back-Cover
Texts. A copy of the license is included in the section entitled
"GNU Free Documentation License". -->
<!-- Created by GNU Texinfo 6.7, http://www.gnu.org/software/texinfo/ -->
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<title>Def Cmd Conventions (GNU Texinfo 6.7)</title>
<meta name="description" content="Def Cmd Conventions (GNU Texinfo 6.7)">
<meta name="keywords" content="Def Cmd Conventions (GNU Texinfo 6.7)">
<meta name="resource-type" content="document">
<meta name="distribution" content="global">
<meta name="Generator" content="texi2any">
<link href="index.html" rel="start" title="Top">
<link href="Command-and-Variable-Index.html" rel="index" title="Command and Variable Index">
<link href="index.html#SEC_Contents" rel="contents" title="Table of Contents">
<link href="Definition-Commands.html" rel="up" title="Definition Commands">
<link href="Sample-Function-Definition.html" rel="next" title="Sample Function Definition">
<link href="Object_002dOriented-Methods.html" rel="prev" title="Object-Oriented Methods">
<style type="text/css">
<!--
a.summary-letter {text-decoration: none}
blockquote.indentedblock {margin-right: 0em}
div.display {margin-left: 3.2em}
div.example {margin-left: 3.2em}
div.lisp {margin-left: 3.2em}
kbd {font-style: oblique}
pre.display {font-family: inherit}
pre.format {font-family: inherit}
pre.menu-comment {font-family: serif}
pre.menu-preformatted {font-family: serif}
span.nolinebreak {white-space: nowrap}
span.roman {font-family: initial; font-weight: normal}
span.sansserif {font-family: sans-serif; font-weight: normal}
ul.no-bullet {list-style: none}
-->
</style>
</head>
<body lang="en">
<span id="Def-Cmd-Conventions"></span><div class="header">
<p>
Next: <a href="Sample-Function-Definition.html" accesskey="n" rel="next">Sample Function Definition</a>, Previous: <a href="Def-Cmds-in-Detail.html" accesskey="p" rel="prev">Def Cmds in Detail</a>, Up: <a href="Definition-Commands.html" accesskey="u" rel="up">Definition Commands</a> [<a href="index.html#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="Command-and-Variable-Index.html" title="Index" rel="index">Index</a>]</p>
</div>
<hr>
<span id="Conventions-for-Writing-Definitions"></span><h3 class="section">14.6 Conventions for Writing Definitions</h3>
<span id="index-Definition-conventions"></span>
<span id="index-Conventions-for-writing-definitions"></span>
<p>When you write a definition using <code>@deffn</code>, <code>@defun</code>, or
one of the other definition commands, please take care to use
arguments that indicate the meaning, as with the <var>count</var> argument
to the <code>forward-word</code> function. Also, if the name of an argument
contains the name of a type, such as <var>integer</var>, take care that the
argument actually is of that type.
</p>
</body>
</html>