[Bf-committers] hello, world... :)

[Benjamin Humpherys]

I can only speak for myself here, but please do!!! 

Those docstrings are invaluable for use with code assistance tools in our editors. Even just a plain triple-quoted comment at the start of your functions/classes/files/etc will help enormously because IDEs can detect and display those. They can’t do the same with inline comments.

Bonus points if you use type annotations in your docstrings. A lot of existing Python code was initially written before PEP484 and so the docstring type annotations are often incompatible with standard Python type checking. 



> On Feb 7, 2019, at 6:02 PM, Jim Bates <jambay9 at gmail.com> wrote:
> 
> follow-up... posted in IRC but no reply, just wondering: are "__doc__"
> headers still used?. can easily change to inline comments if not.
> 
> On Tue, Feb 5, 2019 at 12:09 PM Jim Bates <jambay9 at gmail.com> wrote:
> 
>> Thank you - just wanted to make sure I didn't cause any confusion in the
>> transition. A few of the scripts I worked on in earlier versions are not
>> working well in 2.79 (my 64bit Ubuntu Linux system). Wanted to get an idea
>> of where things were with 2.8 plans and current status.
>> 
>> Thought "clang" was for all code, interesting not applied to Python
>> scripts.
>> 
>> Again, thanks, appreciate the info.
>> 
>> On Tue, Feb 5, 2019 at 9:20 AM Brecht Van Lommel <
>> brechtvanlommel at gmail.com> wrote:
>> 
>>> Hi Jim,
>>> 
>>> The current state of Python addons is that some are updated and some
>>> aren't
>>> yet. Any Python developer can help updating scripts, just check if the
>>> version is set to 2.80 already or not.
>>> 
>>> If there are scripts that you contributed and maintain that you would like
>>> to remove, you can.
>>> 
>>> For documentation, the plan is to move all add-on documentation into the
>>> Blender manual. Any developer or user is also welcome to contribute to
>>> that:
>>> https://docs.blender.org/manual/en/dev/addons/
>>> https://docs.blender.org/manual/en/dev/about/contribute/
>>> 
>>> The clang-format changes would not affect Python code, just C/C++/GLSL.
>>> 
>>> Regards,
>>> Brecht.
>>> 
>>> 
>>> On Mon, Feb 4, 2019 at 6:05 PM Jim Bates <jambay9 at gmail.com> wrote:
>>> 
>>>> I have been away for a long time, just getting back to using Blender and
>>>> have had several chats in IRC threads... this was recommended as a
>>> place to
>>>> discuss some of the topics but I may want to switch to doc and/or python
>>>> groups.
>>>> 
>>>> at present, aside from shoveling snow (IRL), would like to understand
>>>> current state of transition for python script modules and related wiki
>>>> documentation. a few I would recommend as "remove", some others I would
>>>> like to continue. Examples are: "Castle", "Building Basics". these are
>>>> scripts I have worked on in the past.
>>>> 
>>>> Then there's that whole "clang" thing to update style/formatting of
>>> code.
>>>> All good so far as I've seen for renovations. Just trying to get in on
>>>> process so can work with intended goals and expectations.
>>>> 
>>>> AngaMalta is my user name if you care to communicate via IRC (or check
>>> my
>>>> history).
>>>> _______________________________________________
>>>> Bf-committers mailing list
>>>> Bf-committers at blender.org
>>>> https://lists.blender.org/mailman/listinfo/bf-committers
>>>> 
>>> _______________________________________________
>>> Bf-committers mailing list
>>> Bf-committers at blender.org
>>> https://lists.blender.org/mailman/listinfo/bf-committers
>>> 
>> 
> _______________________________________________
> Bf-committers mailing list
> Bf-committers at blender.org
> https://lists.blender.org/mailman/listinfo/bf-committers