383 questions
1 vote
1 answer
106 views
How to add doc comments for variables returned from a function call?
Suppose I have a function like this: function useFrobnaticator() { return (stringToFrobnicate: string) => { console.log(stringToFrobnicate.length > 20 ? '(too long)' : stringToFrobnicate); ...
2 votes
1 answer
60 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 ...
0 votes
0 answers
40 views
Can I label a method in Scaladoc and then link to its documentation?
Linking to overloaded methods is a nightmare, especially since it is typical for argument lists to have common prefixes. Ugly, bug prone, brittle, and current IDEs aren't able to process such ...
1 vote
0 answers
61 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 ...
1 vote
1 answer
223 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 ...
2 votes
0 answers
165 views
Google Billing 7.1.0 documentation is not available on Android Studio
I cant get the documentation for Billing-ktx on Android Studio, I've checked the documentation file and its the same that is available on the official link https://maven.google.com/web/index.html?q=...
0 votes
1 answer
54 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 ...
0 votes
1 answer
53 views
Viewing the "<" symbol in Visual Studio Documentation
I am writing documentation about a function in Visual Studio 2017. At some point, I need "<" symbol. It seems trivial but, the documentation hasn't been shown up. The example situation is ...
1 vote
1 answer
62 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 "...
1 vote
1 answer
107 views
XPATH text() Function & Similar Functions: Where's A Reference?
I'm trying to get better at using XPATH – specifically in Javascript via document.evaluate() Normally, when learning new aspects of Javascript, I do my research on the MDN docs, as they tend to be ...
1 vote
0 answers
177 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, ...
0 votes
1 answer
47 views
is it possible to generate documentation for anonymous classes in rdoc
I would like to document a few methods in an anonymous class for rdoc. I know that alternative documetation tool exists, such as yard, but not sure the project owners are ready for change they ...
0 votes
0 answers
29 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 ...
0 votes
0 answers
161 views
Override or augment setuptools build_ext error messages
I'm trying to build on a fresh Linux installation a CFFI-based package I'm maintaining. However, out of the box, the errors it gives about the dependencies pip couldn't fetch (attached at the end of ...
0 votes
0 answers
33 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 --...