Skip to content

Commit fdd3cc9

Browse files
committed
Fix typos, add Telegram contact
Fix typos, including one in documentation that prevented the docs from being processed and generated into markdown. Added Telegram contact info. Signed-off-by: Winford <[email protected]>
1 parent 14dea42 commit fdd3cc9

File tree

3 files changed

+6
-6
lines changed

3 files changed

+6
-6
lines changed

doc/src/CONTRIBUTING.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
SPDX-License-Identifier: Apache-2.0 OR LGPL-2.1-or-later
55
-->
66

7-
# Contributing
7+
# Contributing Guidelines
88

99
Make sure to understand the license and the contribution guidelines before contributing and last but not least be kind.
1010

@@ -52,8 +52,8 @@ void f(int reverse) {
5252

5353
* Struct names are PascalCase (e.g. Context)
5454
* Scalar types are lower case (e.g. term)
55-
* All other names (e.g. functions and variables) are snake_case (e.g. term_is_integer)
56-
* Always prefix function names (e.g. term_is_nil, term_is_integer, context_new, context_destroy)
55+
* All other names (e.g. functions and variables) are snake\_case (e.g. term\_is\_integer)
56+
* Always prefix function names (e.g. term\_is\_nil, term\_is\_integer, context\_new, context\_destroy)
5757

5858
#### Other Coding Conventions
5959
* Pointer * should be with the variable name rather than with the type (e.g. `char *name`, not `char* name`)

doc/src/welcome-to-atomvm.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -55,9 +55,9 @@ The [AtomVM Github Repository](https://github.com/atomvm/AtomVM) contains the At
5555

5656
## Contributing
5757

58-
The AtomVM community welcomes contributions tot he AtomVM code base and upstream and downstream projects. Please see the [contributing guidelines](../CONTRIBUTING.md) for information about how to contribute.
58+
The AtomVM community welcomes contributions to the AtomVM code base and upstream and downstream projects. Please see the [contributing guidelines](CONTRIBUTING.md) for information about how to contribute.
5959

60-
AtomVM developers can be reached on the #AtomVM discord server.
60+
AtomVM developers can be reached on the #AtomVM discord server or on Telegram at [AtomVM - Erlang and Elixir on Microcontrollers](https://t.me/atomvm).
6161

6262
## Where to go from here
6363

libs/estdlib/src/io_lib.erl

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -49,7 +49,7 @@
4949
%% @doc Format string and data to a string.
5050
%% Approximates features of OTP io_lib:format/2, but
5151
%% only supports ~p and ~n format specifiers.
52-
%% Raises `badarg` error if the number of format specifiers
52+
%% Raises `badarg' error if the number of format specifiers
5353
%% does not match the length of the Args.
5454
%% @end
5555
%%-----------------------------------------------------------------------------

0 commit comments

Comments
 (0)