Skip to content

Commit f3a2d9b

Browse files
0tklarch1t3cht
authored andcommitted
Fix grammar and spelling in comments and documentation
1 parent c85faf8 commit f3a2d9b

File tree

16 files changed

+20
-20
lines changed

16 files changed

+20
-20
lines changed

automation/v4-docs/progress-reporting.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -87,7 +87,7 @@ aegisub.log is preferred since its name is shorter and more general.
8787
4: Debug, some additional data only needed for development.
8888
5: Trace, extremely verbose data showing every tiny step during execution.
8989
The level can be used to let the user limit how severe messages will be
90-
shown, so you eg. can leave trace messages in, yet the casual user of the
90+
shown, so you e.g. can leave trace messages in, yet the casual user of the
9191
script won't see them unless he explicitly enables it.
9292
This argument is optional and can be left out, in which case the message
9393
will always be displayed, regardless of the current trace level set in

libaegisub/common/charset_6937.cpp

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -152,7 +152,7 @@ const extended_range iso6937_extended_codepoints[] = {
152152
{ 0x266A, 0xD5 }
153153
};
154154

155-
/// Get the ISO-6937-2 value for the given unicode codepoint or 0 if it cannot be mapped
155+
/// Get the ISO-6937-2 value for the given Unicode codepoint or 0 if it cannot be mapped
156156
int get_iso6937(int codepoint) {
157157
if (static_cast<size_t>(codepoint) < std::size(iso6937_codepoints))
158158
return iso6937_codepoints[codepoint];
@@ -197,7 +197,7 @@ size_t Converter6937::Convert(const char **inbuf, size_t *inbytesleft, char **ou
197197
char *val_buf = reinterpret_cast<char *>(&in_val);
198198
size_t val_buf_size = sizeof(in_val);
199199

200-
// Get the next unicode character from the input
200+
// Get the next Unicode character from the input
201201
size_t ret = to_ucs4->Convert(&inbuftmp, &inbyteslefttmp, &val_buf, &val_buf_size);
202202
if (ret == (size_t)-1 && errno != E2BIG)
203203
return ret;

libaegisub/common/charset_6937.h

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ namespace agi::charset {
2626
/// While glibc iconv supports ISO-6937-2, GNU libiconv does not due to that
2727
/// it's not used by anything but old subtitle formats
2828
class Converter6937 final : public Converter {
29-
/// Converter to UCS-4 so that we only have to deal with unicode codepoints
29+
/// Converter to UCS-4 so that we only have to deal with Unicode codepoints
3030
std::unique_ptr<Converter> to_ucs4;
3131

3232
/// Should unsupported characters be replaced with '?'

libaegisub/include/libaegisub/ass/smpte.h

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -32,9 +32,9 @@ class SmpteFormatter {
3232
public:
3333
SmpteFormatter(vfr::Framerate fps, char sep=':');
3434

35-
/// Convert an Time to a SMPTE timecode
35+
/// Convert a Time to a SMPTE timecode
3636
std::string ToSMPTE(Time time) const;
37-
/// Convert a SMPTE timecode to an Time
37+
/// Convert a SMPTE timecode to a Time
3838
Time FromSMPTE(std::string const& str) const;
3939
};
4040
}

libaegisub/include/libaegisub/exception.h

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -40,8 +40,8 @@ namespace agi {
4040
///
4141
/// However, there are no public constructors for this class, it should
4242
/// not be instantiated and thrown directly. Throw instances of a
43-
/// relevant sub class, declare a new one if necessary. It is allowed to
44-
/// declare sub classes of Exception and derivatives in private headers
43+
/// relevant subclass, declare a new one if necessary. It is allowed to
44+
/// declare subclasses of Exception and derivatives in private headers
4545
/// and even inside source files, as long as a caller has a chance to
4646
/// catch the exception thrown.
4747
///

libaegisub/include/libaegisub/fs.h

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -154,7 +154,7 @@ bool DirectoryExists(path const& dir);
154154
/// Get the local-charset encoded shortname for a file
155155
///
156156
/// This is purely for compatibility with external libraries which do
157-
/// not support unicode filenames on Windows. On all other platforms,
157+
/// not support Unicode filenames on Windows. On all other platforms,
158158
/// it is a no-op.
159159
std::string ShortName(path const& file_path);
160160

libaegisub/include/libaegisub/json.h

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ json::UnknownElement parse(std::istream &stream);
2424

2525
/// Parse a json stream, with default handler.
2626
/// @param file Path to JSON file.
27-
/// @param default_config Default config file to load incase of nonexistent file
27+
/// @param default_config Default config file to load in case of nonexistent file
2828
/// @return json::UnknownElement
2929
json::UnknownElement file(agi::fs::path const& file, std::string_view default_config);
3030

libaegisub/include/libaegisub/log.h

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -95,7 +95,7 @@ class LogSink {
9595
std::vector<SinkMessage> GetMessages() const;
9696
};
9797

98-
/// An emitter to produce human readable output for a log sink.
98+
/// An emitter to produce human-readable output for a log sink.
9999
class Emitter {
100100
public:
101101
/// Destructor

libaegisub/include/libaegisub/lua/ffi.h

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ static void register_lib_functions(lua_State *) {
3030

3131
template<typename Func, typename... Rest>
3232
void register_lib_functions(lua_State *L, const char *name, Func *func, Rest... rest) {
33-
// This cast isn't legal, but LuaJIT internally requires that it work, so we can rely on it too
33+
// This cast isn't legal, but LuaJIT internally requires it to work, so we can rely on it too
3434
do_register_lib_function(L, name, type_name<Func*>::name().c_str(), (void *)func);
3535
register_lib_functions(L, rest...);
3636
}

libaegisub/include/libaegisub/signal.h

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -79,7 +79,7 @@ class Connection {
7979
/// @brief Disable this connection until Unblock is called
8080
void Block() { if (token) token->blocked = true; }
8181

82-
/// @brief Reenable this connection after it was disabled by Block
82+
/// @brief Re-enable this connection after it was disabled by Block
8383
void Unblock() { if (token) token->blocked = false; }
8484
};
8585

0 commit comments

Comments
 (0)