Emacs
-----
-Optionally check for missing attachements in outgoing messages (see
+Optionally check for missing attachments in outgoing messages (see
function `notmuch-mua-attachment-check`).
Bind `B` to browse URLs in current message.
Errors
======
-All errors occuring due to errors from the underlying notmuch database
+All errors occurring due to errors from the underlying notmuch database
are subclasses of the :exc:`NotmuchError`. Due to memory management
it is possible to try and use an object after it has been freed. In
this case a :exc:`ObjectDestroyedError` will be raised.
However during some peculiar situations, e.g. interpreter
shutdown, it is possible for the :meth:`__del__` method to have
been called, whele there are still references to an object. This
- could result in child objects asking their memeory to be freed
+ could result in child objects asking their memory to be freed
after the parent has already freed the memory, making things
rather unhappy as double frees are not taken lightly in C. To
handle this case all objects need to follow the same protocol to
def _destroy(self):
"""Destroy the object, freeing all memory.
- This method needs to destory the object on the
+ This method needs to destroy the object on the
libnotmuch-level. It must ensure it's not been destroyed by
it's parent object yet before doing so. It also must be
idempotent.
Most data in libnotmuch should be valid ASCII or valid UTF-8.
However since it is a C library these are represented as
- bytestrings intead which means on an API level we can not
+ bytestrings instead which means on an API level we can not
guarantee that decoding this to UTF-8 will both succeed and be
lossless. This string type converts bytes to unicode in a lossy
way, but also makes the raw bytes available.
of it as ``dup = db.remove_message(name); if dup: ...``.
:rtype: bool
- :raises XapianError: A Xapian exception ocurred.
+ :raises XapianError: A Xapian exception occurred.
:raises ReadOnlyDatabaseError: The database is opened in
READ_ONLY mode.
:raises UpgradeRequiredError: The database must be upgraded
:raises LookupError: If no message was found.
:raises OutOfMemoryError: When there is no memory to allocate
the message instance.
- :raises XapianError: A Xapian exception ocurred.
+ :raises XapianError: A Xapian exception occurred.
:raises ObjectDestroyedError: if used after destroyed.
"""
msg_pp = capi.ffi.new('notmuch_message_t **')
a subclass of :exc:`KeyError`.
:raises OutOfMemoryError: When there is no memory to allocate
the message instance.
- :raises XapianError: A Xapian exception ocurred.
+ :raises XapianError: A Xapian exception occurred.
:raises ObjectDestroyedError: if used after destroyed.
"""
if not hasattr(os, 'PathLike') and isinstance(filename, pathlib.Path):
"""Force ending the atomic section.
This can only be called once __exit__ has been called. It
- will attept to close the atomic section (again). This is
+ will attempt to close the atomic section (again). This is
useful if the original exit raised an exception and the atomic
section is still open. But things are pretty ugly by now.
"""Return an iterator of all files for this message.
If multiple files contained the same message ID they will all
- be returned here. The files are returned as intances of
+ be returned here. The files are returned as instances of
:class:`pathlib.Path`.
:returns: Iterator yielding :class:`pathlib.Path` instances.
means the former will yield duplicate keys while the latter won't.
It also means ``len(list(iter(this_map)))`` could be different
than ``len(this_map.keys())``. ``len(this_map)`` will correspond
- with the lenght of the default iterator.
+ with the length of the default iterator.
Be aware that libnotmuch exposes all of this as iterators, so
quite a few operations have O(n) performance instead of the usual
"""
# Since we subclass ImmutableTagSet we inherit a __hash__. But we
- # are mutable, setting it to None will make the Python machinary
+ # are mutable, setting it to None will make the Python machinery
# recognise us as unhashable.
__hash__ = None
:raises TypeError: If the tag is not a valid type.
:raises TagTooLongError: If the added tag exceeds the maximum
- lenght, see ``notmuch_cffi.NOTMUCH_TAG_MAX``.
+ length, see ``notmuch_cffi.NOTMUCH_TAG_MAX``.
:raises ReadOnlyDatabaseError: If the database is opened in
read-only mode.
"""
:raises TypeError: If the tag is not a valid type.
:raises TagTooLongError: If the tag exceeds the maximum
- lenght, see ``notmuch_cffi.NOTMUCH_TAG_MAX``.
+ length, see ``notmuch_cffi.NOTMUCH_TAG_MAX``.
:raises ReadOnlyDatabaseError: If the database is opened in
read-only mode.
"""
class TagsIter(base.NotmuchObject, collections.abc.Iterator):
"""Iterator over tags.
- This is only an interator, not a container so calling
+ This is only an iterator, not a container so calling
:meth:`__iter__` does not return a new, replenished iterator but
only itself.
fixture.
"""
def run(*args):
- """Run a notmuch comand.
+ """Run a notmuch command.
This function runs with a timeout error as many notmuch
commands may block if multiple processes are trying to open
.. note::
Any function in this class can and will throw an
- :exc:`NotInitializedError` if the database was not intitialized
+ :exc:`NotInitializedError` if the database was not initialized
properly.
"""
_std_db_path = None
return Database._get_version(self._db)
def get_revision (self):
- """Returns the committed database revison and UUID
+ """Returns the committed database revision and UUID
- :returns: (revison, uuid) The database revision as a positive integer
+ :returns: (revision, uuid) The database revision as a positive integer
and the UUID of the database.
"""
self._assert_db_is_initialized()
in the meantime. In this case, you should close and
reopen the database and retry.
:exc:`NotInitializedError` if
- the database was not intitialized.
+ the database was not initialized.
"""
self._assert_db_is_initialized()
msg_p = NotmuchMessageP()
case, you should close and reopen the database and
retry.
:raises: :exc:`NotInitializedError` if the database was not
- intitialized.
+ initialized.
*Added in notmuch 0.9*"""
self._assert_db_is_initialized()
"""Returns :class:`Tags` with a list of all tags found in the database
:returns: :class:`Tags`
- :execption: :exc:`NotmuchError` with :attr:`STATUS`.NULL_POINTER
+ :exception: :exc:`NotmuchError` with :attr:`STATUS`.NULL_POINTER
on error
"""
self._assert_db_is_initialized()
:exc:`NullPointerError` if the query creation failed
(e.g. too little memory).
:exc:`NotInitializedError` if the underlying db was not
- intitialized.
+ initialized.
"""
db._assert_db_is_initialized()
# create reference to parent db to keep it alive
(setq label (concat "Unknown key ID " keyid " or unsupported algorithm"))
(setq button-action 'notmuch-crypto-sigstatus-error-callback)
(setq help-msg (concat "Click to retrieve key ID " keyid
- " from keyserver.")))
+ " from key server.")))
((string= status "bad")
(setq label (concat "Bad signature (claimed key ID " keyid ")"))
(setq face 'notmuch-crypto-signature-bad))
;; Workaround: The call to `mm-display-part' below triggers a bug in
;; Emacs 24 if it attempts to use the shr renderer to display an HTML
;; part with images in it (demonstrated in 24.1 and 24.2 on Debian and
-;; Fedora 17, though unreproducable in other configurations).
+;; Fedora 17, though unreproducible in other configurations).
;; `mm-shr' references the variable `gnus-inhibit-images' without
;; first loading gnus-art, which defines it, resulting in a
;; void-variable error. Hence, we advise `mm-shr' to ensure gnus-art
(defun notmuch-mua-pop-to-buffer (name switch-function)
"Pop to buffer NAME, and warn if it already exists and is
-modified. This function is notmuch addaptation of
+modified. This function is notmuch adaptation of
`message-pop-to-buffer'."
(let ((buffer (get-buffer name)))
(if (and buffer
*
* @retval #NOTMUCH_STATUS_READ_ONLY_DATABASE: Database was opened in
* read-only mode so message cannot be modified.
- * @retval #NOTMUCH_STATUS_XAPIAN_EXCEPTION: an execption was thrown
+ * @retval #NOTMUCH_STATUS_XAPIAN_EXCEPTION: an exception was thrown
* accessing the database.
*/
notmuch_status_t
/**
* Remove a (key,value) pair from a message.
*
- * It is not an error to remove a non-existant (key,value) pair
+ * It is not an error to remove a non-existent (key,value) pair
*
* @returns
* - NOTMUCH_STATUS_ILLEGAL_ARGUMENT: *key* may not contain an '=' character.
if (flags & TAG_FLAG_MAILDIR_SYNC) {
status = notmuch_message_tags_to_maildir_flags (message);
if (status) {
- message_error (message, status, "synching tags to maildir");
+ message_error (message, status, "syncing tags to maildir");
return status;
}
}
/*
* Apply a list of tag operations, in order, to a given message.
*
- * Flags can be bitwise ORed; see enum above for possibilies.
+ * Flags can be bitwise ORed; see enum above for possibilities.
*/
notmuch_status_t
EXPECT0(notmuch_message_get_property (message, "testkey2", &val));
printf("testkey2 = %s\n", val);
- /* remove non-existant value for key */
+ /* remove non-existent value for key */
EXPECT0(notmuch_message_remove_property (message, "testkey2", "this value has spaces and = sign"));
EXPECT0(notmuch_message_get_property (message, "testkey2", &val));
printf("testkey2 = %s\n", val);
EOF
test_expect_equal_file EXPECTED OUTPUT
-test_begin_subtest "<> delimeters are required"
+test_begin_subtest "<> delimiters are required"
${TEST_DIRECTORY}/message-id-parse <<EOF >OUTPUT
018b1a8f2d1df62e804ce88b65401304832dfbbf.1346614915.git.jani@nikula.org>
<1530507300.raoomurnbf.astroid@strange.none
/*
* Choose about half ascii as test characters, as ascii
- * punctation and whitespace is the main cause of problems for
+ * punctuation and whitespace is the main cause of problems for
* the (old) restore parser.
*
* We then favour code points with 2 byte encodings. Note that
"Output:\t" (prin1-to-string output) "\n"))
(defun notmuch-test-expect-equal (output expected)
- "Compare OUTPUT with EXPECTED. Report any discrepencies."
+ "Compare OUTPUT with EXPECTED. Report any discrepancies."
(cond
((equal output expected)
t)
projects / notmuch / commitdiff