patchGNU Octave - Patches: patch #9973, Explain DIM parameter in several...

 
 

patch #9973: Explain DIM parameter in several function documentations

Submitter:  None
Submitted:  Thu 17 Sep 2020 05:02:06 AM UTC
   
 
Category:  Forge : other Priority:  1 - Later
Status:  Need Info Privacy:  Public
Assigned to:  None Originator Email:  -email is unavailable-
Open/Closed:  Open
* Mandatory Fields

Add a New Comment Rich Markup
   

Sat 19 Sep 2020 04:47:22 PM UTC, comment #5: 

The latest official Octave documentation can always be found here

https://www.octave.org/doc/latest

There is a semi-official documentation hosted by the "Octave Forge" project, which has a handy search function, but it is slightly out of date (bug #53860):

https://octave.sourceforge.io/docs.php

To get it right, what documentation you are working on?

In any case if you are developing on Linux, you can follow our building guide lines in the wiki to get the latest Octave source code:

https://wiki.octave.org/Building

If you have any trouble with Octave development, best contact other developers at

https://octave.discourse.group/

Kai Torben Ohlhus <siko1056>
Group Member
Fri 18 Sep 2020 02:44:27 PM UTC, comment #4: 

Thanks,for cleaning up and teaching me some lesson.
Now then I am curious how can I get the most recent source for editing it and then push it as a patch?
I also found out that the source forge docs are kinda not the same,the local documentation seems fine.
I noticed the page number from a certain section in the pdf is unsynced.
I think I can enhance some documentations as I learn and use octave.

 Anonymous
Thu 17 Sep 2020 05:43:00 AM UTC, comment #3: 

Octave is a project run by volunteers, these are "modern programmer[s]" like you and hopefully me too 😇

All what Octave is comes for free (no costs, you are allowed to do anything with it).  You don't have to purchase a license (like for MS Windows or Matlab) neither you are limited to use Octave on a certain machine or CPU count.

https://www.octave.org/support-expectations.html

You don't have to use Octave, if it doesn't fit your needs.  I strongly hope/assume there is no one forcing you with a gun to use Octave.

To answer your final question:

original submission:

> But we as a modern programmer can do better than letting users do the guess work or try their luck on search engine right?


Yes:

1. Settle your emotions, nobody here wants to confuse you, annoy you, make you angry, wants to harm you.
2. Describe the part of the unclear documentation, why it is unclear?  After reading comment #1 I still don't get what "the hell" you are trying to do? 🤔
3. Leave a better world that it is now 😇  Do you want your children to read the hate speech of their father when they "try their luck on [a] search engine" one day or to still face this "bad" Octave documentation you are struggling with?  You can always improve something, not only others.
4. (Optional for good "modern programmer[s]") Improve the Octave's code/documentation and submit a patch.  Contributions are greatly appreciated.

 Kai Torben Ohlhus <siko1056>
Group Member
Thu 17 Sep 2020 05:15:21 AM UTC, comment #2: 

sorry,sorry I am dumb.
Ok so I had checked and found out that there is some description for it
something like
1: STATS of columns
2: STATS of rows

actually should be enough to give newbies a hint about the input argument.
It should be literally no quote.1 or 2
Whether the newbie understand and does it correctly
Should be another story.Thus,this patch or thread can be closed by admins.^^ Cheers.

 Anonymous
  Spam posted by anonymous
Thu 17 Sep 2020 05:02:06 AM UTC, original submission:  

As stated most newbie that doesn't have experience will TOTALLY have no idea what DIM is. The only hint is short form for dimension but what dimension?vertical,horizontal? If so,then how do they tell computer (input arguments).
They will think like:"h"?"v"?"1"?does 1 represent anything to the parser?Do I just simply type "vertical"? or are the dimension refering to cartesian plane x axis and y axis looking at the matrix?put "x"?

All in all.The old documentation is kinda bad and inherited since long time ago.It's probably because inherited from Matlab just make it work at the initial growth.

But we as a modern programmer can do better than letting users do the guess work or try their luck on search engine right?

 Anonymous

 

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

Attach Files:
   
   
Comment:
   

No files currently attached

 

Depends on the following items: None found

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 None (Submitted the item)

    •  

    There are 0 votes so far. Votes easily highlight which items people would like to see resolved in priority, independently of the priority of the item set by tracker managers.

    Only logged-in users can vote.

     

    Follow 3 latest changes.

    Date Changed by Updated Field Previous Value => Replaced by
    2020-09-17 siko1056 SummaryA link to explain what the hell is DIM in most function to newbie Explain DIM parameter in several function documentations
    2020-09-17 siko1056 Priority5 - Normal 1 - Later
        StatusNone Need Info

    Back to the top

    Copyright © 2024 Free Software Foundation, Inc.
    Verbatim copying and distribution of this entire article is permitted in any medium, provided this notice is preserved.
    The Levitating, Meditating, Flute-playing Gnu logo is a GNU GPL'ed image provided by the Nevrax Design Team.
    Page source code

    Powered by Savane 3.13-72d9.
    Corresponding source code