Well, since this is about comments and code, let’s look at some actual code. Compare this typical code: float a, b, c; a=9.81; b=5; c= .5*a*(b^2); To this self-documenting code, which shows what is being done: const float gravitationalForce = 9.81; float timeInSeconds = 5; float displacement = (1 / 2) * gravitationalForce * (timeInSeconds … Read more
You can use // MARK: There has also been discussion that liberal use of class extensions might be a better practice anyway. Since extensions can implement protocols, you can e.g. put all of your table view delegate methods in an extension and group your code at a more semantic level than #pragma mark is capable … Read more
I want to offer an update on the current status of the Pinterest API. There is still no public API available. Pinterest also does not seem to be approving anyone who applies for access on their site. As of right now, the endpoints of the Pinterest v3 API are almost complete although there is no … Read more
Here is an example of all the options I have found as of Xcode 5.0.2 That was generated with this code: /** First line text. Putting \\n doesn’t create a new line.\n One way to create a newline is by making sure nothing is on that line. Not even a single space character! @a Italic … Read more
That is not ES6 but has only been added in ECMAScript 2018. It is called “Object Rest/Spread Properties” and is part of the Spread Syntax.
So why is API documentation written in such a way as to confuse perennial newbs / hackers / DIYers like myself? It’s really not meant to be written that way. I’ll agree there seems to be no ease of use across API documentations. However, there is a lot of cross over from older man style … Read more
B business day frequency C custom business day frequency (experimental) D calendar day frequency W weekly frequency M month end frequency SM semi-month end frequency (15th and end of month) BM business month end frequency CBM custom business month end frequency MS month start frequency SMS semi-month start frequency (1st and 15th) BMS business month … Read more
It’s the string formatting operator. Read up on string formatting in Python. format % values Creates a string where format specifies a format and values are the values to be filled in.
Formats Python docstrings can be written following several formats as the other posts showed. However the default Sphinx docstring format was not mentioned and is based on reStructuredText (reST). You can get some information about the main formats in this blog post. Note that the reST is recommended by the PEP 287 There follows the … Read more
You can use triple-quoted strings. When they’re not a docstring (the first thing in a class/function/module), they are ignored. ”’ This is a multiline comment. ”’ (Make sure to indent the leading ”’ appropriately to avoid an IndentationError.) Guido van Rossum (creator of Python) tweeted this as a “pro tip”. However, Python’s style guide, PEP8, … Read more