Skip to content

Commit

Permalink
Merge pull request #1803 from flopp/spelling
Browse files Browse the repository at this point in the history
Fix some spelling errors - mostly in comments & documentation.
  • Loading branch information
nlohmann committed Oct 21, 2019
2 parents 0245ae5 + b93d414 commit 00cb98a
Show file tree
Hide file tree
Showing 14 changed files with 20 additions and 20 deletions.
2 changes: 1 addition & 1 deletion doc/examples/json_pointer__operator_add.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ int main()
json::json_pointer ptr("/foo");
std::cout << ptr << '\n';

// apppend a JSON Pointer
// append a JSON Pointer
ptr /= json::json_pointer("/bar/baz");
std::cout << ptr << '\n';

Expand Down
2 changes: 1 addition & 1 deletion doc/examples/json_pointer__operator_add_binary.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ int main()
// create a JSON pointer
json::json_pointer ptr("/foo");

// apppend a JSON Pointer
// append a JSON Pointer
std::cout << ptr / json::json_pointer("/bar/baz") << '\n';

// append a string
Expand Down
2 changes: 1 addition & 1 deletion include/nlohmann/detail/conversions/to_chars.hpp
Original file line number Diff line number Diff line change
Expand Up @@ -330,7 +330,7 @@ inline cached_power get_cached_power_for_binary_exponent(int e)
// ==> 2^(q - 1 + alpha) <= c * 2^(e + q)
// ==> 2^(alpha - e - 1) <= c
//
// If c were an exakt power of ten, i.e. c = 10^k, one may determine k as
// If c were an exact power of ten, i.e. c = 10^k, one may determine k as
//
// k = ceil( log_10( 2^(alpha - e - 1) ) )
// = ceil( (alpha - e - 1) * log_10(2) )
Expand Down
2 changes: 1 addition & 1 deletion include/nlohmann/detail/input/binary_reader.hpp
Original file line number Diff line number Diff line change
Expand Up @@ -1929,7 +1929,7 @@ class binary_reader
/*!
@param[in] format the current format
@param[in] detail a detailed error message
@param[in] context further contect information
@param[in] context further context information
@return a message string to use in the parse_error exceptions
*/
std::string exception_message(const input_format_t format,
Expand Down
4 changes: 2 additions & 2 deletions include/nlohmann/detail/iterators/iter_impl.hpp
Original file line number Diff line number Diff line change
Expand Up @@ -121,8 +121,8 @@ class iter_impl
/*!
@brief const copy constructor
@param[in] other const iterator to copy from
@note This copy constuctor had to be defined explicitely to circumvent a bug
occuring on msvc v19.0 compiler (VS 2015) debug build. For more
@note This copy constructor had to be defined explicitly to circumvent a bug
occurring on msvc v19.0 compiler (VS 2015) debug build. For more
information refer to: https://github.com/nlohmann/json/issues/1608
*/
iter_impl(const iter_impl<const BasicJsonType>& other) noexcept
Expand Down
2 changes: 1 addition & 1 deletion include/nlohmann/detail/json_pointer.hpp
Original file line number Diff line number Diff line change
Expand Up @@ -126,7 +126,7 @@ class json_pointer
/*!
@brief append an array index at the end of this JSON pointer
@param[in] array_index array index ot append
@param[in] array_index array index to append
@return JSON pointer with @a array_index appended
@liveexample{The example shows the usage of `operator/=`.,json_pointer__operator_add}
Expand Down
2 changes: 1 addition & 1 deletion include/nlohmann/json.hpp
Original file line number Diff line number Diff line change
Expand Up @@ -4019,7 +4019,7 @@ class basic_json
/*!
@brief check the existence of an element in a JSON object given a JSON pointer
Check wehther the given JSON pointer @a ptr can be resolved in the current
Check whether the given JSON pointer @a ptr can be resolved in the current
JSON value.
@note This method can be executed on any JSON value type.
Expand Down
12 changes: 6 additions & 6 deletions single_include/nlohmann/json.hpp
Original file line number Diff line number Diff line change
Expand Up @@ -7056,7 +7056,7 @@ class binary_reader
/*!
@param[in] format the current format
@param[in] detail a detailed error message
@param[in] context further contect information
@param[in] context further context information
@return a message string to use in the parse_error exceptions
*/
std::string exception_message(const input_format_t format,
Expand Down Expand Up @@ -9414,8 +9414,8 @@ class iter_impl
/*!
@brief const copy constructor
@param[in] other const iterator to copy from
@note This copy constuctor had to be defined explicitely to circumvent a bug
occuring on msvc v19.0 compiler (VS 2015) debug build. For more
@note This copy constructor had to be defined explicitly to circumvent a bug
occurring on msvc v19.0 compiler (VS 2015) debug build. For more
information refer to: https://github.com/nlohmann/json/issues/1608
*/
iter_impl(const iter_impl<const BasicJsonType>& other) noexcept
Expand Down Expand Up @@ -10187,7 +10187,7 @@ class json_pointer
/*!
@brief append an array index at the end of this JSON pointer

@param[in] array_index array index ot append
@param[in] array_index array index to append
@return JSON pointer with @a array_index appended

@liveexample{The example shows the usage of `operator/=`.,json_pointer__operator_add}
Expand Down Expand Up @@ -12966,7 +12966,7 @@ inline cached_power get_cached_power_for_binary_exponent(int e)
// ==> 2^(q - 1 + alpha) <= c * 2^(e + q)
// ==> 2^(alpha - e - 1) <= c
//
// If c were an exakt power of ten, i.e. c = 10^k, one may determine k as
// If c were an exact power of ten, i.e. c = 10^k, one may determine k as
//
// k = ceil( log_10( 2^(alpha - e - 1) ) )
// = ceil( (alpha - e - 1) * log_10(2) )
Expand Down Expand Up @@ -18549,7 +18549,7 @@ class basic_json
/*!
@brief check the existence of an element in a JSON object given a JSON pointer

Check wehther the given JSON pointer @a ptr can be resolved in the current
Check whether the given JSON pointer @a ptr can be resolved in the current
JSON value.

@note This method can be executed on any JSON value type.
Expand Down
2 changes: 1 addition & 1 deletion test/src/unit-cbor.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -1287,7 +1287,7 @@ TEST_CASE("CBOR")
}
}

SECTION("additonal deserialization")
SECTION("additional deserialization")
{
SECTION("0x7b (string)")
{
Expand Down
2 changes: 1 addition & 1 deletion test/src/unit-class_parser.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -210,7 +210,7 @@ json parser_helper(const std::string& s)
json j;
json::parser(nlohmann::detail::input_adapter(s)).parse(true, j);

// if this line was reached, no exception ocurred
// if this line was reached, no exception occurred
// -> check if result is the same without exceptions
json j_nothrow;
CHECK_NOTHROW(json::parser(nlohmann::detail::input_adapter(s), nullptr, false).parse(true, j_nothrow));
Expand Down
2 changes: 1 addition & 1 deletion test/src/unit-msgpack.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -1359,7 +1359,7 @@ TEST_CASE("MessagePack roundtrips" * doctest::skip())
{
SECTION("input from msgpack-python")
{
// most of these are exluded due to differences in key order (not a real problem)
// most of these are excluded due to differences in key order (not a real problem)
auto exclude_packed = std::set<std::string>
{
"test/data/json.org/1.json",
Expand Down
2 changes: 1 addition & 1 deletion test/src/unit-regression.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -164,7 +164,7 @@ TEST_CASE("regression tests")
{
SECTION("issue #60 - Double quotation mark is not parsed correctly")
{
SECTION("escape_dobulequote")
SECTION("escape_doublequote")
{
auto s = "[\"\\\"foo\\\"\"]";
json j = json::parse(s);
Expand Down
2 changes: 1 addition & 1 deletion test/src/unit-udt.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -238,7 +238,7 @@ void from_json(const nlohmann::json& j, contact_book& cb)
TEST_CASE("basic usage" * doctest::test_suite("udt"))
{

// a bit narcissic maybe :) ?
// a bit narcissistic maybe :) ?
const udt::age a
{
23
Expand Down
2 changes: 1 addition & 1 deletion test/src/unit-unicode.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -1152,7 +1152,7 @@ TEST_CASE("Unicode" * doctest::skip())
json j;
CHECK_NOTHROW(f >> j);

// the array has 1112064 + 1 elemnts (a terminating "null" value)
// the array has 1112064 + 1 elements (a terminating "null" value)
// Note: 1112064 = 0x1FFFFF code points - 2048 invalid values between
// 0xD800 and 0xDFFF.
CHECK(j.size() == 1112065);
Expand Down

0 comments on commit 00cb98a

Please sign in to comment.