After an evaluation, GNOME has moved from Bugzilla to GitLab. Learn more about GitLab.
No new issues can be reported in GNOME Bugzilla anymore.
To report an issue in a GNOME project, go to GNOME GitLab.
Do not go to GNOME Gitlab for: Bluefish, Doxygen, GnuCash, GStreamer, java-gnome, LDTP, NetworkManager, Tomboy.
Bug 681935 - Documentation for the history view
Documentation for the history view
Status: RESOLVED FIXED
Product: gnome-calculator
Classification: Core
Component: docs
6.4.x
Other Linux
: Normal normal
: ---
Assigned To: Maintainers of Gnome user documentation
gcalctool maintainers
Depends on: 327590
Blocks:
 
 
Reported: 2012-08-15 19:11 UTC by Gopal Krishnan
Modified: 2017-02-12 07:19 UTC
See Also:
GNOME target: ---
GNOME version: ---


Attachments
Documentation for the history view (17.38 KB, patch)
2012-08-15 19:11 UTC, Gopal Krishnan
needs-work Details | Review
Fixed patch for history page (2.18 KB, patch)
2017-01-27 20:34 UTC, SanketDG
committed Details | Review
Fixed patch (2.39 KB, patch)
2017-02-12 05:16 UTC, SanketDG
committed Details | Review

Description Gopal Krishnan 2012-08-15 19:11:31 UTC
Created attachment 221302 [details] [review]
Documentation for the history view

This will create the documentation for the history view created in bug: 327590 . It is created in the user interface section of the existing documentation and can be selected from there.
Comment 1 Kat 2013-04-18 19:34:32 UTC
Review of attachment 221302 [details] [review]:

This page needs to be added to the help/Makefile.am and retake the screenshot using the Aidwaita theme, but it would actually be better not to have the screenshot as they adds lots of extra work for translators.

In general the content is fine, but here are some point on which it can be improved:

::: help/C/history.page
@@ +1,3 @@
+<page xmlns="http://projectmallard.org/1.0/"
+      type="guide"
+      id="history">

<page xmlns="http://projectmallard.org/1.0/"
      xmlns:its="http://www.w3.org/2005/11/its"
      type="topic" style="task"
      id="history">

@@ +5,3 @@
+    <info>
+        <link type="guide" xref="index#ui"/>
+    </info>

<info>
    <link type="guide" xref="index#ui />
    <revision pkgversion="3.8" version="0.1" date="2013-04-18" status="review"/>

    <credit type="author copyright">
      <name>Gopal Krishnan</name>
      <email its:translate="no">ingeniumed@outlook.com</email>
      <years>2012, 2013</years>
    </credit>

  </info>

@@ +14,3 @@
+    The History View is located above the entry box and is designed to show your previous calculations in the form of a scrollable list 
+    that can be clicked and scrolled through using a mouse or even navigated and selected using the arrow keys on a keyboard. Once an 
+    entry has been selected, it will immediately show up in the entry box for you to manipulate and use. Finally, there isn't an upper 

"is not", it is better not to use contractions.

@@ +16,3 @@
+    entry has been selected, it will immediately show up in the entry box for you to manipulate and use. Finally, there isn't an upper 
+    limit on the number of calculations that can show up in the list for you to use.
+    </p>

It would be great if you could reflow this paragraph to 79 characters wide.
Comment 2 Tiffany Antopolski 2013-07-07 04:48:15 UTC
This patch depends of the merging of the patch at Bug #327590, as it describes a feature implemented there.
Comment 3 SanketDG 2017-01-27 20:34:46 UTC
Created attachment 344439 [details] [review]
Fixed patch for history page

This has been inactive for quite some time, so I took this up.

I have fixed the suggestions that were given in the previous review, removed the image and added the entry to help/Makefile.am.

Since most of the content was written by the previous author, I was not sure of what to do in the <credit> tag, so I left it as suggested.
Comment 4 Robert Roth 2017-02-06 19:18:38 UTC
Review of attachment 344439 [details] [review]:

Thanks for taking this, it has been neglected indeed, your contributions are welcome. Please take into account a couple of minor nitpicks, and I'll be ready to push your next version with those fixed.
Comment 5 Robert Roth 2017-02-06 19:21:07 UTC
Review of attachment 344439 [details] [review]:

And now with the minor change requests.

::: help/C/history.page
@@ +23,3 @@
+    using the arrow keys on a keyboard. Once an entry has been selected, it
+    will immediately show up in the entry box for you to manipulate and use.
+    Finally, there isn't an upper limit on the number of calculations that can

As the previous review stated, contractions should not be used, so this should be something like "there is no upper limit ..."

::: help/Makefile.am
@@ +19,3 @@
              financial.page \
              functions.page \
+	     history.page \

Please use spaces for indenting, instead of mixed spaces and tabs.
Comment 6 SanketDG 2017-02-12 05:16:55 UTC
Created attachment 345556 [details] [review]
Fixed patch

- Add myself as author
- Fix grammar
- Never mix spaces and tabs!
Comment 7 SanketDG 2017-02-12 05:18:12 UTC
Hi Robert,

I have updated the patch.

Thanks.
Comment 8 Robert Roth 2017-02-12 07:19:52 UTC
This problem has been fixed in the unstable development version. The fix will be available in the next major software release. You may need to upgrade your Linux distribution to obtain that newer version.