[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[Octave-bug-tracker] [bug #57041] Missing matlab function: startsWith
From: |
Markus Mützel |
Subject: |
[Octave-bug-tracker] [bug #57041] Missing matlab function: startsWith |
Date: |
Fri, 21 Feb 2020 12:17:26 -0500 (EST) |
User-agent: |
Mozilla/5.0 (Windows NT 10.0; Win64; x64; rv:74.0) Gecko/20100101 Firefox/74.0 |
Follow-up Comment #14, bug #57041 (project octave):
Thanks for your contribution.
Just a few nitpicks:
- The first argument of @deftypefn and @deftypefnx should be empty.
- Try to use the same input and output argument names in the doc string that
you use in the function definition.
- Usually, we try to start the docstring with a compact one liner that
summarizes what the function does.
- I appreciate the examples in the docstring. But also document in full
sentences what all input arguments are supposed to mean.
- Use a space after "if".
- Use a space after "!". I was told it should be understood as the English
word "not" which would also be followed by a space.
- Use a space after "##" or "#".
- Use spaces before and after "=" and in-place operators.
- Use a space between function names and opening bracket (mostly correct).
- I don't know if this is a rule. But I usually try to add spaces after commas
that separate input arguments of functions.
- Lines should not be longer than 80 characters.
- I see many constructs like "size (pattern)(1)*size (pattern)(2)". Would
"numel (pattern)" be clearer? Or am I missing something?
- We usually start claiming copyright in the year the function was written.
Please, don't feel discouraged by the list. Your contribution looks quite good
already.
_______________________________________________________
Reply to this item at:
<https://savannah.gnu.org/bugs/?57041>
_______________________________________________
Message sent via Savannah
https://savannah.gnu.org/
- [Octave-bug-tracker] [bug #57041] Missing matlab function: startsWith, (continued)
- [Octave-bug-tracker] [bug #57041] Missing matlab function: startsWith, Abdallah Khaled Elshamy, 2020/02/18
- [Octave-bug-tracker] [bug #57041] Missing matlab function: startsWith, Abdallah Khaled Elshamy, 2020/02/18
- [Octave-bug-tracker] [bug #57041] Missing matlab function: startsWith, Markus Mützel, 2020/02/18
- [Octave-bug-tracker] [bug #57041] Missing matlab function: startsWith, Abdallah Khaled Elshamy, 2020/02/18
- [Octave-bug-tracker] [bug #57041] Missing matlab function: startsWith, Abdallah Khaled Elshamy, 2020/02/18
- [Octave-bug-tracker] [bug #57041] Missing matlab function: startsWith, Dmitri A. Sergatskov, 2020/02/18
- [Octave-bug-tracker] [bug #57041] Missing matlab function: startsWith, Markus Mützel, 2020/02/18
- [Octave-bug-tracker] [bug #57041] Missing matlab function: startsWith, Abdallah Khaled Elshamy, 2020/02/18
- [Octave-bug-tracker] [bug #57041] Missing matlab function: startsWith, Abdallah Khaled Elshamy, 2020/02/18
- [Octave-bug-tracker] [bug #57041] Missing matlab function: startsWith, Abdallah Khaled Elshamy, 2020/02/19
- [Octave-bug-tracker] [bug #57041] Missing matlab function: startsWith,
Markus Mützel <=
- [Octave-bug-tracker] [bug #57041] Missing matlab function: startsWith, John W. Eaton, 2020/02/21
- Message not available
- Message not available
- [Octave-bug-tracker] [bug #57041] Missing matlab function: startsWith, Abdallah Khaled Elshamy, 2020/02/21
- [Octave-bug-tracker] [bug #57041] Missing matlab function: startsWith, Abdallah Khaled Elshamy, 2020/02/21
- [Octave-bug-tracker] [bug #57041] Missing matlab function: startsWith, Abdallah Khaled Elshamy, 2020/02/21
- [Octave-bug-tracker] [bug #57041] Missing matlab function: startsWith, Abdallah Khaled Elshamy, 2020/02/21
- [Octave-bug-tracker] [bug #57041] Missing Matlab functions: startsWith and endsWith, Markus Mützel, 2020/02/23
- [Octave-bug-tracker] [bug #57041] Missing Matlab functions: startsWith and endsWith, Abdallah Khaled Elshamy, 2020/02/23