jyapayne/Nim
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

contributing docs: symbols need package prefix; changed allocStats to nimAllocStats (#13247)

Browse source
This commit is contained in:
Timothee Cour 2020-01-25 01:27:29 -07:00 • committed by Andreas Rumpf
commit 981ffc912e
10 changed files with 23 additions and 9 deletions
Download patch file Download diff file Expand all files Collapse all files

14
doc/contributing.rst
View file

@ -271,6 +271,20 @@ Note: these are general guidelines, not hard rules; there are always exceptions.
Code reviews can just point to a specific section here to save time and
propagate best practices.
.. _define_needs_prefix:
New `defined(foo)` symbols need to be prefixed by the nimble package name, or
by `nim` for symbols in nim sources (e.g. compiler, standard library). This is
to avoid name conflicts across packages.
.. code-block:: nim
# if in nim sources
when defined(allocStats): discard # bad, can cause conflicts
when defined(nimAllocStats): discard # preferred
# if in a pacakge `cligen`:
when defined(debug): discard # bad, can cause conflicts
when defined(cligenDebug): discard # preferred
.. _noimplicitbool:
Take advantage of no implicit bool conversion