Skip to content

Commit

Permalink
Updated documentation, mistake in explanation of pop
Browse files Browse the repository at this point in the history
  • Loading branch information
Koryphon committed Apr 29, 2018
1 parent fa3ee65 commit a0084ba
Show file tree
Hide file tree
Showing 2 changed files with 3 additions and 3 deletions.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -58,7 +58,7 @@ The following functions are available to manage the ring buffer.

### pop(data)

If the buffer is not empty, ```pop(data)``` pops a data from the end of the ring buffer, puts it in ```data``` and return ```true```. If the buffer is empty ```data``` is unchanged and ```false``` is returned.
If the buffer is not empty, ```pop(data)``` pops a data from the beginning of the ring buffer, puts it in ```data``` and return ```true```. If the buffer is empty ```data``` is unchanged and ```false``` is returned.

### lockedPop(data)

Expand Down
4 changes: 2 additions & 2 deletions src/RingBuffer.h
Original file line number Diff line number Diff line change
Expand Up @@ -20,8 +20,8 @@
* Note about interrupt safe implementation
*
* To be safe from interrupts, a sequence of C instructions must be framed
* by a pair of interrupt diable and enable instructions and ensure that the
* compiler will not move writing variables to memory outside the protected
* by a pair of interrupt disable and enable instructions and ensure that the
* compiler will not move writing of variables to memory outside the protected
* area. This is called a critical section. Usually the manipulated variables
* receive the volatile qualifier so that any changes are immediately written
* to memory. Here the approach is different. First of all you have to know
Expand Down

0 comments on commit a0084ba

Please sign in to comment.