WIP: document our guidelines/coding conventions by sciunto · Pull Request #2616 · scikit-image/scikit-image

sciunto · 2017-04-14T20:22:25Z

Description

As discussed on the ML, in this PR, we will start to list our guidelines related to our API.

https://mail.python.org/archives/list/scikit-image@python.org/thread/QKGR7YSC34MMXWFWLZNHHL3HJCBSAXN3/

TODO

fix numbers in enumerate
DOI for references
Default value for multichannel SKIP: Consistency of multichannel parameter handling #2613
Decide about gray/grey SKIP: gray vs grey #2604

References

https://github.com/numpy/numpy/blob/master/doc/HOWTO_DOCUMENT.rst.txt

stefanv · 2017-04-14T23:35:50Z

GUIDELINES.txt

@@ -0,0 +1,7 @@
+Guidelines


Guidelines & Coding Conventions, perhaps?

Coding conventions would be great. Especially naming conventions.

stefanv · 2017-04-14T23:36:25Z

GUIDELINES.txt

@@ -0,0 +1,7 @@
+Guidelines
+==========
+


Now just to figure out what common pieces of advice we give contributors :)

soupault · 2017-04-19T07:41:57Z

GUIDELINES.rst.txt

+
+    from skimage import data
+
+    img = data.coins()


This has to be image :)

@soupault Please, read my comment: #2538 (comment) and add your point of view :)

Works fine to me either way. :)

jni · 2018-06-24T13:06:24Z

@sciunto I wouldn't consider this dead, just dormant, thanks for awakening it. =) As a first step, I would remove all the copied sections from NumPyDoc and just link to the official guide:

https://numpydoc.readthedocs.io/en/latest/format.html

Overall I think this is a great addition! But I think use image. =P

sciunto · 2018-10-28T08:52:46Z

I abandon this PR, I'm not motivated to continue on this. If someone else wants to document that, I'll be glad.

hmaarrfk

I feel like most of this is or should be upstreamed. No need to duplicate it here.

hmaarrfk · 2019-09-12T17:06:15Z

GUIDELINES.rst.txt

+Docstring
+---------
+
+ documentation string (docstring) is a string that describes a module,


Capitalization. Leading space

hmaarrfk · 2019-09-12T17:07:54Z

GUIDELINES.rst.txt

+output.  Rather than sacrificing the readability of the docstrings, we
+have written pre-processors to assist Sphinx_ in its task.
+
+The length of docstring lines should be kept to 75 characters to


I think this should be removed. This has fallen out of favor in recent years... Let's move on from the 70s

hmaarrfk · 2019-09-12T17:09:26Z

GUIDELINES.rst.txt

+   If it is not necessary to specify a keyword argument, use
+   ``optional``::
+
+     x : int, optional


I know you all have been adding optional, but I feel like this is the expected default from a keyword argument that has been specified in the signature.

hmaarrfk · 2019-09-12T17:10:14Z

GUIDELINES.rst.txt

+    demonstrated function, must be explicit.
+
+
+cumenting classes


sciunto · 2019-09-12T17:18:10Z

If you want to continue this PR, feel free! :)

hmaarrfk · 2019-09-12T17:26:49Z

Not particularly. I guess I didn't see the point that you abbandoned it too.

jni · 2019-09-13T04:31:47Z

Totally into this PR, but there are quite a few changes I'd make. As @hmaarrfk, anything that can be upstreamed, should, by pointing to PEP257 and NumPy's docstring formatting guidelines. I don't have time to do it now but let's leave it open so the work is ready to be picked up by someone.

GUIDELINES.rst.txt

lagru · 2022-08-18T12:46:43Z

I'm slowly going through the 1.0 milestone. Removing this from 1.0 as this is more a general documentation improvement and not specific to a release.

sciunto added 💬 Discussion 📄 type: Documentation Updates, fixes and additions to documentation 💪 Work in progress labels Apr 14, 2017

stefanv reviewed Apr 14, 2017

View reviewed changes

sciunto mentioned this pull request Apr 15, 2017

Respect standard notations for images in functions arguments #2617

Merged

sciunto changed the title ~~WIP: document our guidelines~~ WIP: document our guidelines/coding conventions Apr 15, 2017

soupault reviewed Apr 19, 2017

View reviewed changes

sciunto added this to the 0.14 milestone May 5, 2017

sciunto modified the milestones: 0.14, 0.15 Jan 22, 2018

sciunto mentioned this pull request Jun 24, 2018

Attribute operators #2680

Merged

7 tasks

sciunto removed the 💪 Work in progress label Oct 28, 2018

sciunto modified the milestones: 0.15, 1.0 Jan 19, 2019

sciunto mentioned this pull request Sep 12, 2019

Define standard common argument's names #4154

Closed

hmaarrfk reviewed Sep 12, 2019

View reviewed changes

emmanuelle mentioned this pull request Apr 12, 2020

2020's calendar of community management #4486

Closed

stefanv reviewed Apr 15, 2020

View reviewed changes

GUIDELINES.rst.txt Outdated Show resolved Hide resolved

sciunto mentioned this pull request Aug 12, 2020

Terminology: n_jobs vs num_workers vs ncpu etc. #4876

Closed

sciunto force-pushed the guidelines branch from 678d57e to b22307c Compare August 30, 2020 06:37

Start guidelines

7a98e61

sciunto force-pushed the guidelines branch from b22307c to 7a98e61 Compare August 30, 2020 06:38

Base automatically changed from master to main February 18, 2021 18:22

mkcor mentioned this pull request Feb 22, 2021

2021's calendar of community management #5169

Closed

lagru added the 🆘 To take over label Aug 18, 2022

lagru removed this from the 1.0 milestone Aug 18, 2022

lagru added the 💪 Work in progress label Aug 18, 2022

lagru mentioned this pull request Aug 21, 2022

2022's calendar of community management #6165

Closed

Uh oh!

Conversation

sciunto commented Apr 14, 2017 • edited by lagru Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

TODO

References

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

jni commented Jun 24, 2018

Uh oh!

sciunto commented Oct 28, 2018

Uh oh!

hmaarrfk left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

sciunto commented Sep 12, 2019 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

hmaarrfk commented Sep 12, 2019

Uh oh!

jni commented Sep 13, 2019

Uh oh!

Uh oh!

lagru commented Aug 18, 2022

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

7 participants

sciunto commented Apr 14, 2017 •

edited by lagru

Loading

sciunto commented Sep 12, 2019 •

edited

Loading