From 0b861ac7a5dfa2a7b7d03f320693aa72d70bafd0 Mon Sep 17 00:00:00 2001 From: Cam Cook Date: Sun, 2 Apr 2023 13:12:21 -0400 Subject: [PATCH] Documentation corrections for GtkTextIter | method | current | suggestion | |------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------|-----------------------------------------------------------------| | [backward_visible_cursor_position](https://gitlab.gnome.org/GNOME/gtk/-/blob/main/gtk/gtktextiter.c#L3785) | "Moves @iter forward to the previous visible cursor position" | "Moves @iter backward to the previous visible cursor position." | | [get_offset](https://gitlab.gnome.org/GNOME/gtk/-/blob/main/gtk/gtktextiter.c#L595) | "Use [method@Gtk,TextBuffer.get_iter_at_offset]" | "Use [method@Gtk.TextBuffer.get_iter_at_offset]" | | [starts_tag](https://gitlab.gnome.org/GNOME/gtk/-/blob/main/gtk/gtktextiter.c#L1201) | "returns %TRUE, [method@Gtk.TextIter.has_tag" | "returns %TRUE, [method@Gtk.TextIter.has_tag] " | | method | current | suggestion | |--------------------------------------------------------------------------------------------------------|-----------------------------------------------------|-----------------------------------------------------------| | [backward_cursor_position](https://gitlab.gnome.org/GNOME/gtk/-/blob/main/gtk/gtktextiter.c#L3715) | "Like gtk_text_iter_forward_cursor_position()" | "Like [method@Gtk.TextIter.forward_cursor_position]" | | [backward_find_char](https://gitlab.gnome.org/GNOME/gtk/-/blob/main/gtk/gtktextiter.c#L4483) | "Same as gtk_text_iter_forward_find_char()" | "Same as [method@Gtk.TextIter.forward_find_char]" | | [backward_search](https://gitlab.gnome.org/GNOME/gtk/-/blob/main/gtk/gtktextiter.c#L5295) | "Same as gtk_text_iter_forward_search()" | "Same as [method@Gtk.TextIter.forward_search]" | | [backward_sentence_starts](https://gitlab.gnome.org/GNOME/gtk/-/blob/main/gtk/gtktextiter.c#L3611) | "Calls gtk_text_iter_backward_sentence_start()" | "Calls [method@Gtk.TextIter.backward_sentence_start]" | | [backward_visible_word_starts](https://gitlab.gnome.org/GNOME/gtk/-/blob/main/gtk/gtktextiter.c#L3421) | "Calls gtk_text_iter_backward_visible_word_start()" | "Calls [method@Gtk.TextIter.backward_visible_word_start]" | | [backward_word_starts](https://gitlab.gnome.org/GNOME/gtk/-/blob/main/gtk/gtktextiter.c#L3345) | "Calls gtk_text_iter_backward_word_start()" | "Calls [method@Gtk.TextIter.backward_word_start]" | | [forward_sentence_ends](https://gitlab.gnome.org/GNOME/gtk/-/blob/main/gtk/gtktextiter.c#L3591) | "Calls gtk_text_iter_forward_sentence_end()" | "Calls [method@Gtk.TextIter.forward_sentence_end]" | | [forward_to_end](https://gitlab.gnome.org/GNOME/gtk/-/blob/main/gtk/gtktextiter.c#L4131) | "gtk_text_iter_get_char() called on" | "[method@Gtk.TextIter.get_char] called on" | | [forward_visible_word_ends](https://gitlab.gnome.org/GNOME/gtk/-/blob/main/gtk/gtktextiter.c#L3403) | "Calls gtk_text_iter_forward_visible_word_end()" | "Calls [method@Gtk.TextIter.forward_visible_word_end]" | | [forward_word_ends](https://gitlab.gnome.org/GNOME/gtk/-/blob/main/gtk/gtktextiter.c#L3327) | "Calls gtk_text_iter_forward_word_end()" | " Calls [method@Gtk.TextIter.forward_word_end]" | | [is_end](https://gitlab.gnome.org/GNOME/gtk/-/blob/main/gtk/gtktextiter.c#L1664) | "gtk_text_iter_is_end() is the most efficient" | "[method@Gtk.TextIter.is_end] is the most efficient" | | [set_line_index](https://gitlab.gnome.org/GNOME/gtk/-/blob/main/gtk/gtktextiter.c#L3900) | "Same as gtk_text_iter_set_line_offset()" | "Same as [method@Gtk.TextIter.set_line_offset]" | | [set_visible_line_index](https://gitlab.gnome.org/GNOME/gtk/-/blob/main/gtk/gtktextiter.c#L3987) | "Like gtk_text_iter_set_line_index()" | "Like [method@Gtk.TextIter.set_line_index]" | | [set_visible_line_offset](https://gitlab.gnome.org/GNOME/gtk/-/blob/main/gtk/gtktextiter.c#L3946) | "Like gtk_text_iter_set_line_offset()" | "Like [method@Gtk.TextIter.set_line_offset]" | --- gtk/gtktextiter.c | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/gtk/gtktextiter.c b/gtk/gtktextiter.c index 5d30db747b..4b47e3e168 100644 --- a/gtk/gtktextiter.c +++ b/gtk/gtktextiter.c @@ -1661,7 +1661,7 @@ gtk_text_iter_ends_line (const GtkTextIter *iter) * Returns %TRUE if @iter is the end iterator. * * This means it is one past the last dereferenceable iterator - * in the buffer. [method@Gtk.TextBuffer.is_end] is the most efficient + * in the buffer. [method@Gtk.TextIter.is_end] is the most efficient * way to check whether an iterator is the end iterator. * * Returns: whether @iter is the end iterator @@ -3897,7 +3897,7 @@ gtk_text_iter_set_line_offset (GtkTextIter *iter, * @iter: a `GtkTextIter` * @byte_on_line: a byte index relative to the start of @iter’s current line * - * Same as [method@Gtk.TextBuffer.set_line_offset], but works with a + * Same as [method@Gtk.TextIter.set_line_offset], but works with a * byte index. The given byte index must be at * the start of a character, it can’t be in the middle of a UTF-8 * encoded character. @@ -3943,7 +3943,7 @@ gtk_text_iter_set_line_index (GtkTextIter *iter, * @iter: a `GtkTextIter` * @char_on_line: a character offset * - * Like [method@Gtk.TextBuffer.set_line_offset], but the offset is in visible + * Like [method@Gtk.TextIter.set_line_offset], but the offset is in visible * characters, i.e. text with a tag making it invisible is not * counted in the offset. */ @@ -3984,7 +3984,7 @@ gtk_text_iter_set_visible_line_offset (GtkTextIter *iter, * @iter: a `GtkTextIter` * @byte_on_line: a byte index * - * Like [method@Gtk.TextBuffer.set_line_index], but the index is in visible + * Like [method@Gtk.TextIter.set_line_index], but the index is in visible * bytes, i.e. text with a tag making it invisible is not counted * in the index. */