Documentation that focuses on code itself, such as its function, correct use, expected output, relationship to other code as well as database and tables connections, and usage examples.
Questions tagged [code-documentation]
381 questions
3
votes
3 answers
How to properly document class' static variables?
What is the preferred way to document static variables in classes?
class Foo(object):
"""
Foo doc.
"""
bar = 'bar'
"""
Bar doc.
"""
class Foo(object):
"""
Foo doc.
"""
# Bar doc.
bar =…
morgoth84
- 1,070
- 2
- 11
- 25
3
votes
1 answer
is it possible to build a debugger around the java scripting engine?
we are using the java 6 scripting engine in our product, and now we are thinking on adding some debugging abilities.
my question is:
is it possible? does the java 6 scripting engine has the same capabilities like rhino as far as debugging.
some…
special0ne
- 6,063
- 17
- 67
- 107
3
votes
3 answers
Python Interpreter Mode - What are some ways to explore Python's modules and its usage
While inside the Python Interpreter:
What are some ways to learn about the packages I have?
>>> man sys
File "", line 1
man sys
^
SyntaxError: invalid syntax
>>> sys --help
Traceback (most recent call last):
File "", line…
Jack Chi
- 440
- 4
- 13
2
votes
3 answers
Xcode Documentation Generator
I've looked at Headerdoc and Doxygen for documenting source code, but they both seem to need the developer to do most of the leg-work first. In Visual Studio, typing \\\ generates the skeleton for documentation including the parameters expected by a…
Echilon
- 10,064
- 33
- 131
- 217
2
votes
1 answer
Rust-like comment compilation for kotlin/java?
in short, rust compiler can compile certain code in comments, such as example code, against the actual code - resulting in always up to date commentary.
Anyone aware of any sort-of-equivalent for Kotlin or Java Code?
Any suggestions?
Had a hard time…
MomStopFlashing
- 255
- 1
- 2
- 7
2
votes
1 answer
Altair documentation example not working due to a Javascript Error
The following code block comes entirely from Altair documentation, it's one of the example graphs.
import altair as alt
from vega_datasets import data
source = data.population.url
select_year = alt.selection_point(
name="Year",
…
RavenbornJB
- 31
- 4
2
votes
0 answers
What is the preferred way to reference another class or method from a function's documentation?
Suppose I have:
@dataclass(match_args = True)
class Foo:
# a ton of attributes
...
def update(self, **kwargs):
"""Update the Foo.
Keyword Args:
(a ton of text)
"""
for arg in self.__match_args__:
if arg…
Chris
- 28,822
- 27
- 83
- 158
2
votes
0 answers
How do I read or interpret the Angular ngrx documentation correctly?
I have the createAction function from ngrx.io Store... with that signature:
https://v11.ngrx.io/api/store/createAction
createAction(type: T, config?: C | { _as: "props"; }): ActionCreator
and…
MMMM
- 3,320
- 8
- 43
- 80
2
votes
1 answer
How to make Python help() function work well with decorators?
Python has the nice help() built-in that displays the doc string of an object. When I use it in the REPL passing a function in my module it nicely displays:
>>> help(mymodule.myfunction)
Help on function myfunction in module…
neves
- 33,186
- 27
- 159
- 192
2
votes
2 answers
How to document LWC Salesforce components public variables with JSDoc?
JSDoc skips my public LWC variables.
Here is an example:
/**
* SomePublicVarName mode - default is false.
*
* @type {boolean}
*/
@api
somePublicVarName = false;
If I convert that to a function or a public…
Florian G
- 567
- 1
- 5
- 15
2
votes
1 answer
What is the best way to resolve merge conflicts in .swm files?
When trying to rebase my feature branch on the base branch (dev), I got merge conflicts on swm and generated md files:
The conflicts themselves are hard to understand on their own, and include many of file blob changes in the .swm file:
<<<<<<<…
Shay Nehmad
- 1,103
- 1
- 12
- 25
2
votes
1 answer
How does the swimm verify command scope change?
I'm part of the beta using Swimm for documentation and have created some documents with coupled code snippets. I'm able to verify that the documents have up to date snippets using the swimm verify command, as follows:
13:00:13:~/Desktop/code/repo %…
michaelh
- 434
- 3
- 11
2
votes
1 answer
Microsoft documentation for a typical Excel 365 object refers to "an object in the Applies To list", but where is the "Applies to list"?
I think my Question's title clearly expresses the essence of the information I need. I Googled where is the "applies to list" in vba excel and a few variations of that, all with quotes as shown, which should make Google look for that exact phrase. I…
DSlomer64
- 4,234
- 4
- 53
- 88
2
votes
1 answer
How to validate whether a c++ program is well documented using Doxygen format or not?
Is there a way for Doxygen to report whether source code is documented or not? Is there any way to identify the set of files which are not well documented in a set of C++ source files?
Coding Language: C++
Documentation Tool : Doxygen (This can be…
Thomas Easo
- 3,457
- 3
- 21
- 32
2
votes
0 answers
Why are Pandas Documentation Pages being Flagged as Unsafe by Google Search?
Pandas Warning Screen
Pandas Warning Detail
Some pages from Pandas' official docs are being flagged as Unsafe by Google.
bpw1009
- 99
- 1
- 4