[Bug 2239811] Review Request: python-pynsgr - Interface to the NeuroScience Gateway REST interface

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

 



https://bugzilla.redhat.com/show_bug.cgi?id=2239811



--- Comment #9 from Sandro <gui1ty@xxxxxxxxxxxxx> ---
(In reply to Ben Beasley from comment #8)
> I find a man page more ergonomic even if it is merely a lightly-formatted
> regurgitation of the help text.

But what we have now looks kinda ugly. And in this specific case, I would
resort to the help text, rather than using the man pages. The formatting
(linebreaks, etc,) is just not very readable. Compare:

    -r
        remove a job.  Deletes input and output data and all info about the
job.  Cancels
        the job if it's waiting to run or running.

    For example:
        nsgr_job -l
            list the user's jobs
        nsgr_job -j JOBHANDLE
            shows status of the job whose jobhandle is JOBHANDLE
        nsgr_job -j JOBHANDLE -d
            download's results of the job whose jobhandle is JOBHANDLE
        nsgr_job -j JOBHANDLE -r
            cancel and remove the specified job.

to:

       -r

       remove a job.
              Deletes input and output data and all info about the job. 
Cancels

              the job if it's waiting to run or running.

              For example:

              nsgr_job -l

              list the user's jobs

              nsgr_job -j JOBHANDLE

              shows status of the job whose jobhandle is JOBHANDLE

              nsgr_job -j JOBHANDLE -d

              download's results of the job whose jobhandle is JOBHANDLE

              nsgr_job -j JOBHANDLE -r

              cancel and remove the specified job.

The summum of doing this right is the way `git` does it, in my opinion. But, as
I already mentioned, at least the man pages are no longer broken. And they are
not blocking this review being granted.

> I would say it’s a bug, because spewing a traceback is an ugly way to report
> an error, but at least the exception message is useful (basically: “you need
> to configure authentication credentials first, and here’s where you should
> put them.”)

But this may well be. I think the exception should be caught and only the
message should be shown to the user.

I'll sleep over it and give Ankur a chance to comment.


-- 
You are receiving this mail because:
You are on the CC list for the bug.
You are always notified about changes to this product and component
https://bugzilla.redhat.com/show_bug.cgi?id=2239811

Report this comment as SPAM: https://bugzilla.redhat.com/enter_bug.cgi?product=Bugzilla&format=report-spam&short_desc=Report%20of%20Bug%202239811%23c9
_______________________________________________
package-review mailing list -- package-review@xxxxxxxxxxxxxxxxxxxxxxx
To unsubscribe send an email to package-review-leave@xxxxxxxxxxxxxxxxxxxxxxx
Fedora Code of Conduct: https://docs.fedoraproject.org/en-US/project/code-of-conduct/
List Guidelines: https://fedoraproject.org/wiki/Mailing_list_guidelines
List Archives: https://lists.fedoraproject.org/archives/list/package-review@xxxxxxxxxxxxxxxxxxxxxxx
Do not reply to spam, report it: https://pagure.io/fedora-infrastructure/new_issue




[Index of Archives]     [Fedora Users]     [Fedora Desktop]     [Fedora SELinux]     [Yosemite Conditions]     [KDE Users]

  Powered by Linux