Skip to content
GitLab
Explore
Sign in
Register
Primary navigation
Search or go to…
Project
T
tarantool
Manage
Activity
Members
Labels
Plan
Issues
Issue boards
Milestones
Wiki
Code
Merge requests
Repository
Branches
Commits
Tags
Repository graph
Compare revisions
Snippets
Build
Pipelines
Jobs
Pipeline schedules
Artifacts
Deploy
Releases
Package Registry
Container Registry
Model registry
Operate
Environments
Terraform modules
Monitor
Incidents
Analyze
Value stream analytics
Contributor analytics
CI/CD analytics
Repository analytics
Model experiments
Help
Help
Support
GitLab documentation
Compare GitLab plans
Community forum
Contribute to GitLab
Provide feedback
Keyboard shortcuts
?
Snippets
Groups
Projects
Show more breadcrumbs
core
tarantool
Commits
cc53cf54
Commit
cc53cf54
authored
8 years ago
by
lenkis
Browse files
Options
Downloads
Patches
Plain Diff
Added recent agreements.
parent
45486015
No related branches found
Branches containing commit
No related tags found
Tags containing commit
No related merge requests found
Changes
1
Hide whitespace changes
Inline
Side-by-side
Showing
1 changed file
doc/sphinx/dev_guide/documentation_guidelines.rst
+5
-8
5 additions, 8 deletions
doc/sphinx/dev_guide/documentation_guidelines.rst
with
5 additions
and
8 deletions
doc/sphinx/dev_guide/documentation_guidelines.rst
+
5
−
8
View file @
cc53cf54
...
...
@@ -55,7 +55,11 @@ all nested content that follows in the method description).
Language and style issues
===========================================================
*TBD (to be discussed)*
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
US vs British spelling
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
We use English US spelling.
===========================================================
Examples and templates
...
...
@@ -111,17 +115,10 @@ Here is an example of documenting a module (``my_box.index``), a class
.. method:: rename(index-name)
Rename an index.
*Here follow 2 different notations for the same set of parameters.*
:param index_object: an object reference
:param index_name: a new name for the index (type = string)
Parameters:
* :samp:`{index_object}` = an object reference;
* :samp:`{index-name}` (type = string) = new name for index.
:return: nil
Possible errors: index_object does not exist.
...
...
This diff is collapsed.
Click to expand it.
Preview
0%
Loading
Try again
or
attach a new file
.
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Save comment
Cancel
Please
register
or
sign in
to comment