bugGNU Octave - Bugs: bug #56389, Documentation for webXXX functions

 
 

bug #56389: Documentation for webXXX functions

Submitted by:  Rik <rik5>
Submitted on:  Sun 26 May 2019 01:02:05 AM UTC  
 
Category:  Documentation Severity:  3 - Normal
Priority:  5 - Normal Item Group:  Documentation
Status:  Fixed Assigned to:  None
Originator Name:  Open/Closed:  Closed
Release:  dev Operating System:  Any

Add a New Comment (Rich Markup)
   

You are not logged in

Please log in, so followups can be emailed to you.

 

( Jump to the original submission)

Thu 06 Jun 2019 03:47:55 AM UTC, comment #7: 

I did some work on webwrite, webread, and weboptions in these changesets:

https://hg.savannah.gnu.org/hgweb/octave/rev/a498fab46e03

https://hg.savannah.gnu.org/hgweb/octave/rev/fe1fccf0d292

https://hg.savannah.gnu.org/hgweb/octave/rev/09eedaac54cb

I found a regression in the implementation of classdef which I will report in a new bug.  I think this bug report has been fixed so I'm closing the report.

Rik <rik5>
Project Administrator
Wed 05 Jun 2019 10:32:10 AM UTC, comment #6: 

@Rik: Thanks for your contributions as well! =)

Kai Torben Ohlhus <siko1056>
Project Member
Wed 05 Jun 2019 10:29:47 AM UTC, comment #5: 

@Guillaume: Thanks for testing and patching: https://hg.savannah.gnu.org/hgweb/octave/rev/224ce8329074

Kai Torben Ohlhus <siko1056>
Project Member
Wed 05 Jun 2019 09:24:31 AM UTC, comment #4: 

@Kai: Thanks for pushing your implementation of web(). One tiny thing I noticed, for compatibility with Matlab, is that nothing is returned if you don't specify an output argument. Not sure what is the preferred way for this: either using varargout or as below:

diff -r f0da934bca61 scripts/web/web.m
--- a/scripts/web/web.m Tue Jun 04 15:27:42 2019 -0700
+++ b/scripts/web/web.m Wed Jun 05 10:11:01 2019 +0100
@@ -93,12 +93,8 @@
     url = ["file://" fname];
   endif

-  status = __open_with_system_app__ (url);
-  if (status == 1)
-    status = 0;
-  else
-    status = 2;
-  endif
+  sts = __open_with_system_app__ (url);
+  sts = ifelse (sts == 1, 0, 2);

   h = [];  # Empty handle, as we cannot control an external browser.

@@ -107,6 +103,10 @@
     url = [];
   endif

+  if (nargout > 0)
+    status = sts;
+  endif
+
endfunction

Guillaume <gyom>
Tue 04 Jun 2019 12:53:53 PM UTC, comment #3: 

Comment #2, yes it is planned. There is an updated version https://github.com/octave-de/octave-web/blob/master/web/web.m to test if you like.  "websave" is WIP, too.

Kai Torben Ohlhus <siko1056>
Project Member
Tue 04 Jun 2019 09:56:26 AM UTC, comment #2: 

The octave-web repository mentioned in comment #1 contains an implementation of web(): is it also planned to be merged into Octave?

Guillaume <gyom>
Sat 01 Jun 2019 08:18:22 PM UTC, comment #1: 

Greetings Rik!

It's been about time I did my part at Octave, was busy with University work. Hopefully I'm now in a position to fix these bugs :)

Coming to weboptions, although I did write the documentation for this function, but because it is a Classdef class, the parser fails to recognize it. I'll try to look if I can come up with something and report you back in a day or two.

As for the websave function, it has been drafted as part of compatibility with MATLAB's RESTful interface (See this for the intended plan). But before that, I would like to address some of the issues in webread and webwrite which were deliberately left out to be done after GSoC as they were not-so-high priority items.

Sahil <batterylow>
Sun 26 May 2019 01:02:05 AM UTC, original submission:  

The NEWS file mentions webread, webwrite, and weboptions as functions for interacting with RESTful web services.

The docstrings for webread, webwrite say

 See 'help weboptions' for a complete list of supported HTTP options.

But the function/structure weboptions has no documentation.  I.e., 'help weboptions' returns nothing.

Also, 'websave' is mentioned in the Seealso list of functions.  However, websave does not appear to exist.

Rik <rik5>
Project Administrator

 

(Note: upload size limit is set to 16384 kB, after insertion of the required escape characters.)

Attach Files:
   
   
Comment:
   

No files currently attached

 

Digest:
   bug dependencies.

Items that depend on this one: None found

 

Carbon-Copy List
  • -email is unavailable- added by siko1056 (Posted a comment)
  • -email is unavailable- added by gyom (Posted a comment)
  • -email is unavailable- added by batterylow (Posted a comment)
  • -email is unavailable- added by rik5 (Submitted the item)
  •  

    Do you think this task is very important?
    If so, you can add your encouragement to it.
    This task has 0 encouragements so far.

    Only project members can vote.

     

     

     

    Follow 3 latest changes.

    Date Changed by Updated Field Previous Value => Replaced by
    2019-06-06 rik5 StatusConfirmed => Fixed
        Open/ClosedOpen => Closed
    2019-06-02 siko1056 Dependencies- => Depends on bugs #43047

    Back to the top


    Powered by Savane 3.5