385 questions
2
votes
1
answer
42
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,053
0
votes
0
answers
33
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 ...
- 2,312
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
0
votes
0
answers
22
views
Sandcastle: VS IDE index.html doesn't show content
I'm using Sandcastle Visual Studio integration (VS 2022). I have a documentation project which creates a chm file. Everything works fine, all namespaces are listed. I don't use any special setup, the ...
1
vote
1
answer
183
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
2
votes
0
answers
151
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
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
0
votes
1
answer
52
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 ...
- 501
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
1
answer
98
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 ...
- 11
1
vote
0
answers
166
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
1
answer
43
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 ...
- 3,845
0
votes
0
answers
17
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
142
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 ...
- 1,117
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
38
views
Suggestions for contributing to Documentation
Big fan of this project and hoping to contribute to the documentation. This is something I would like to do quite a bit of over the course of the next year or two. Wondering if someone might suggest ...
0
votes
1
answer
866
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
377
views
Why is the PDF generation using make.bat generated by Doxygen (LateX, refman.tex) on Windows not working?
I'm trying to generate LateX based code documentation using doxygen and using the make.bat created by doxygen to generate from LateX (refman.tex) a PDF.
Installations:
Operating System: Windows
...
- 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
3
votes
1
answer
100
views
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 ...
- 265
2
votes
1
answer
582
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
131
views
What does Kotlin coroutines documentation mean when they say joinAll() is semantically equivalent to calling join() in sequence?
In https://kotlinlang.org/api/kotlinx.coroutines/kotlinx-coroutines-core/kotlinx.coroutines/join-all.html it's stated that "This method is semantically equivalent to joining all given jobs one by ...
- 101
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
918
views
Pyomo, how to make a constraint with two decision variables from two different Set()
I have an Abstract Pyomo optimization problem where I have two decision variables that are defined in two separate Set().
These are named model.BATTERY and model.HYDROGEN.
The constraint that I want ...
- 17
0
votes
1
answer
105
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
1
vote
0
answers
33
views
How Python's "Changed in version" statements are generated?
I'm curios how the "Changed in version" statements are generated in Python's docs.
Consider the documentation for namedtuple:
Changed in version 3.1: Added support for rename.
Changed in ...
- 185
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
0
votes
0
answers
14
views
Where can I find some fetch documentation on autogenerated content-type? [duplicate]
If I write some code to do a fetch for some multipart/form-data which looks like:
const authorization = btoa('AAAAA:BBBBB')
const data = new FormData()
data.append('grant_type', 'password')
data....
- 796
1
vote
1
answer
713
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 ...
3
votes
0
answers
474
views
Show Python method's API documentation from a URL on hover in VSCode
Is it possible to have VSCode show a Python method's online documentation upon mouse-over/hover?
For example, PyTorch API Docs are hosted online and the method hierarchy is simple to navigate. When I ...
- 8,655
0
votes
1
answer
736
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 | ...
0
votes
1
answer
37
views
Get date from datestring
I saw you do it for someone but I can't click anything and it doesn't make sense to me to do myself can someone tell me the date out of this dateString 1663099299947 and please explain so I can figure ...
- 1
1
vote
1
answer
979
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
0
votes
1
answer
64
views
JavaScript documentation issue when having functions with the same name
I am working on a JavaScript library and trying to keep it well documented.
I am structuring it in a way that I will end-up with functions for different objects, but the same name, and when adding ...
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
3
votes
1
answer
882
views
C# Documentation: refer to other property
Suppose I have this class
public sealed class Person
{
public string FirstName { get; set; }
public string LastName { get; set; }
public string DisplayName => $"{FirstName} {LastName}&...
1
vote
1
answer
981
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
0
votes
1
answer
255
views
A graph description language for binary streams (network packets, binary file formats)
I'm looking for a graph description language to document binary streams like network packets or binary file formats (described in code, then output as a graph).
Something in the same idea that DOT/...
- 11
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
2
votes
0
answers
98
views
Vs Code does not show flutter quick documentations while typing code
When I started with it, I used to get these quick docs where it would for example explain what the class would do or show the different color shades alongwith their numbers but now it doesnt and Ive ...
- 114
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
79
views
How does the Angular team manage feature flags in the framework?
The Angular team uses a website to document upgrades
https://update.angular.io/
In that website, one can select how to upgrade from version to version and it displays a detailed list of steps to ...
- 520
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
563
views
Using PostgreSQL comments as descriptions in dbt docs
We've been adding comments to the columns in postgres as column descriptions. Similarly, there are descriptions in dbt that can be written.
How would I go about writing SQL to automatically setting ...
- 145
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
-3
votes
2
answers
978
views
What is the official status of Windows' UMS API?
Windows 7 added an API set called UMS which allowed you to reclaim threads from user mode, and implement custom scheduling logic.
Starting with Windows 11 this feature does not appear to work. This ...
- 1,025
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
5
votes
0
answers
534
views
R Roxygen2 documentation without building a package
I am currently programming within an R project. Right now there is no need for building a whole package, but I would like to use roxygen to create documentation of several functions nonetheless.
...
- 223
-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
3
votes
1
answer
663
views
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 ...
- 40.3k