IntenseFinance/gnucash
3
0
Fork 0
mirror of https://github.com/Gnucash/gnucash.git synced 2025-02-25 18:55:30 -06:00
Code Issues Packages Projects Releases Wiki Activity

Update key-value policy.

Browse Source 
git-svn-id: svn+ssh://svn.gnucash.org/repo/gnucash/trunk@2734 57a11ea4-9604-0410-9ed3-97b8803252fd
This commit is contained in:
Dave Peticolas 2000-08-31 07:15:02 +00:00
parent a11ffa70df
commit 248e7f0740
1 changed files with 13 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

15
src/doc/design/engine.texinfo
View File

@ -248,15 +248,26 @@ the use of keys and values. Please consult this document before planning
any use of new keys. any use of new keys.
@item @item
Key strings should be in all lower case with the @code{'_'} character Key strings should be in all lower case with the '_' character
separating words. Example: @code{"bank_info"} separating words. If possible, use only alphanumeric characters
and '_'. Example: @code{"bank_info"}
@item @item
Favor longer, descriptive key strings over short ones. Example: Favor longer, descriptive key strings over short ones. Example:
@code{"online_banking_info"} is better than @code{"onln_bnk"}. @code{"online_banking_info"} is better than @code{"onln_bnk"}.
@item
Make use of the fact that frames can be stored in frames. If a group
of keys are used for a related purpose, consider storing them together
in a sub-frame.
@item
Values should generally not be accessed directly through keys, but
should rather be accessed through specific API calls.
@end itemize @end itemize
@node Sessions, Account Groups, Key-Value Pair Frames, Engine @node Sessions, Account Groups, Key-Value Pair Frames, Engine
@section Sessions @section Sessions
@tindex Session @tindex Session