385 questions
2
votes
1
answer
45
views
Is it possible to enable PyCharm external documentation hotkey from the Evaluate window?
PyCharm supports customisable lookups of library functions and methods via hotkeys, which are set in the Settings -> Tools -> Python External Documentation and some entry examples are here.
And ...
- 1,055
1
vote
0
answers
53
views
How to disable duplicate parameter documentation in Sphinx / ReadTheDocs theme
When documenting Python code using Sphinx (v8.2.3), the parameters of the class' initializer __init__(self, ...) are documented two times:
in the class' description
in the dunder init method
I ...
- 16.5k
1
vote
1
answer
184
views
Obsolete attribute - Avoid magic string
I want to mark an old class as Obsolete and redirect to the new class in the Obsolete attribute comment. However, if I write the new class name as a magic string, I won't be able to use the might of ...
- 77
0
votes
1
answer
44
views
Different dropDuplicates signature in Databricks and official py spark code
I noticed that on Databricks pyspark calling help(Databricks) returns
dropDuplicates(self, *subset: Union[str, List[str]]) -> 'DataFrame'
which is different from the official version (without a ...
- 3
1
vote
1
answer
57
views
Visual Studio hint, while working with C# classes
In my C# program, I have the following source code:
if ((Int32.Parse(u_Message.PK1)
When hovering my mouse above the word Int32, this is what I see:
I'm especially interested in the phrase "...
- 17.6k
1
vote
0
answers
167
views
Why are my function parameters in PyCharm docstrings displayed twice?
This is what my function looks like:
def convert_lesions(input_lesions: list, output: str) -> list:
"""
Convert a list of IDs/class names to a list of corresponding IDs, ...
- 185
0
votes
0
answers
18
views
I can't put text like [static] on the right side of the page for a certain function in doxygen
What is the syntax to put a short test note or a tag on the right side of the page to indicate some kind of a property of a function like a nothrow or static.
see the image how Qt does it.
I could ...
- 1,180
0
votes
0
answers
28
views
Where is the git documentation that specifies that a reset can take a branch name as an argument?
I've scanned the documentation here and I see no mention of how to reset to a branch's latest commit. I only see [<commit>] used but sure enough, you can specifiy 'origin/develop' in git reset --...
- 1,050
0
votes
1
answer
868
views
How should data be formatted to train the Huggingface DPR model?
I am new to machine learning, so maybe I have completely overlooked something, but I am trying to finetune the DPR models from the Huggingface transformers model using a dataset I am building (https://...
- 1
0
votes
1
answer
135
views
The getter 'size' isn't defined for the type 'TaskData'
This is one of the cases that makes it is difficult to learn flutter.
Here is an example directly from (code source):
import 'package:flutter/material.dart';
import 'package:provider/provider.dart';
...
- 41
2
votes
1
answer
585
views
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....
- 31
0
votes
1
answer
90
views
How do I refer specifically to "this" instance of a class instead of another instance which is one of the parameters of the method?
I wasn't sure if this question should go here or somewhere else.
I'm trying to document my C++ code but I'm having trouble describing things without being verbose.
So let's say I have a class Number
...
0
votes
1
answer
106
views
How can I inherit the docstring of the class in my constructor
I have a class to generate test data that I have documented with a docstring.
/// <summary>
/// In this scenario the user is new to the group, but may have existed from before.
/// </summary&...
- 1,072
4
votes
1
answer
296
views
Autogenerate Console Output for Roxygen @examples Section
Background
I am documenting an R package, and I wish the @examples section(s) to include the (commented) output below the code, so the user need not run the examples (in the console, etc.) in order to ...
- 3,368
1
vote
1
answer
714
views
JSDoc object with value props as key
I have an items object with Items like this:
class Item {
/**
*@type {number}
*/
id;
}
let items = {};
I want to document the fact that keys of items is value.id is there a way ot ...
0
votes
1
answer
737
views
JSDoc function returning a parameter of itself
I need to document a function returning conditionally one of its parameters. But JSDoc seems not to accept variables as a return value.
I tried to do something like this following the return type {1 | ...
1
vote
1
answer
980
views
Where have SDL2 wiki examples gone?
In this video (https://www.youtube.com/watch?v=qPHKWsZK2Jc&list=PLvv0ScY6vfd-p1gSnbQhY7vMe2rng0IL0&index=10) from about a year ago, there is example code on the SDL_CreateWindow function ...
- 105
3
votes
1
answer
2k
views
webview_flutter migration V4 Doc
How do I make my current code compatible with V4 update I checked their documentation but
I couldn't follow along
final Completer<WebViewController> _controller = Completer<WebViewController&...
- 233
1
vote
1
answer
982
views
Documenting APIs - /me endpoints
I have a portfolio where I display my work (mostly backend API stuff with minimal UI to interact with) and am currently documenting the APIs. What I have is a page per project along with the ...
- 312
2
votes
0
answers
26
views
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)
...
- 31.7k
1
vote
1
answer
2k
views
In matplotlib legend how to define number of columns in horizontal legend (ncol or ncols)?
I was having a difficult time fixing the display of a legend in one matplotlib figure, and then I noticed that maybe there is an incongruence in matplotlib documentation, or I am not searching in the ...
- 993
0
votes
0
answers
1k
views
How do I run doxygen from command prompt to generate html files
Need to generate python code doxygen document using automatic process.
while developing this need to run doxygen from command prompt, so I need windows command for that so I can run doxygen from ...
- 45
2
votes
1
answer
138
views
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<T extends string, C extends Creator>(type: T, config?: C | { ...
- 3,613
7
votes
2
answers
417
views
Official recommendation / coding style guide on using multiple @throws tags for the same exception in JavaDoc
I just recently found out that one can use multiple @throws tags for the same exception in Javadoc.
One of my students used it to document one of his methods in Connect Four:
/*
* ...
* @throws ...
- 12.8k
-1
votes
1
answer
153
views
Where to find the documentation for frappe on the github repo?
I'm on the frappe github repo and I need to find the folder that contains the documentation to contribute to it. A link to it would be super helpful .
- 19