4,693 questions
- Bountied 0
- Unanswered
- Frequent
- Score
- Trending
- Week
- Month
- Unanswered (my tags)
Advice
0
votes
1
replies
33
views
Are Kafka Heartbeat messages running on independent thread or are they linked to consumer poll and commit?
Is Kafka consumer heartbeat message same as consumer poll and commit? Or does it run on a separate thread and keeps sending heartbeat to Kafka broker as long as the consumer JVM is responding?
The ...
0
votes
0
answers
60
views
Wikipedia returns 403 when using sphinx linkcheck to check for broken links
We use sphinx linkcheck to make sure that our docs do not contain broken links, but Wikipedia has started returning a 403, assuming that our CI is a robot. Fair enough, it is a robot, so has anyone ...
Tooling
0
votes
3
replies
51
views
How to configure IntelliJ IDEA to include parameter and return types in auto-generated JavaDoc?
Is there a way to make Intellij add the types of the parameters and the return values in its auto-generated java documentation?
My desired documentation format would look like this:
/**
* Calculates ...
Tooling
1
vote
0
replies
38
views
Use a json body as point of reference for documentation
I am looking to move away from Excel spreadsheets. I want my json body to be the point of reference for mapping UI entry field, Database table.name.field, data exchange etc. Does this make sense?
Advice
0
votes
5
replies
48
views
Generating Interactive Documentation from Javascript Source Code
I’m working on an Electron project, and I can generate JSON for my code using JSDoc:
jsdoc -X > data.json
I want to use this JSON output to create a live, searchable documentation site similar to ...
0
votes
0
answers
43
views
How does the GJS documentation pipeline work with DevDocs?
I’ve noticed that GJS documentation uses DevDocs.
I’m trying to understand the documentation pipeline for GJS:
Does it read comments from the source code and generate documentation automatically?
Do ...
0
votes
0
answers
60
views
Sphinx sphinx-apidoc generated module titles are too long (full package path). How can I shorten them?
I am generating python API documentation using Sphinx and sphinx-apidoc with sphinx-rtd-theme
The problem is:
The page titles and ToC entries for modules/packages always show the full import path,
e....
0
votes
0
answers
25
views
Attach a TSDoc comment to a `export * as myModule from './my-module'`
Against ts_ls, the hover action on myModule above does not result in the documentation popping up. I've tried
/** Here is a documentation comment! */
export * as myModule from './my-module';
I've ...
1
vote
0
answers
48
views
Docsearch Typesense scraper only finds records on Docusaurus landing page
Problem
I’m using Docusaurus with Typesense and the docsearch-typesense-scraper to index my documentation site.
Everything runs fine — the sitemap is found, and the scraper produces records.
However, ...
0
votes
0
answers
68
views
How to show a single version dropdown per product in Docusaurus multi-product documentation?
I’m building documentation for multiple products on a single Docusaurus 3 website. Each product has its own versions, and I want users to be able to select a product first, then optionally select a ...
2
votes
1
answer
82
views
Why doesn’t Xcode show documentation for class initializers when creating an object in Swift?
I’m working with Swift and I’ve documented my class initializers using ///.
However, when I create an object with let obj = MyClass(...), the documentation does not appear when I Option-Click the ...
0
votes
0
answers
38
views
SAML attribute for SaaS apps
I am working with Single Sign-On (SSO) using SAML for multiple SaaS applications. Each SaaS provider requires different attribute mappings (for example: email, firstName, lastName, NameID, etc.).
I ...
0
votes
1
answer
51
views
How to generate documentation for multiple files using pydoc
I tried to generate documentation for my python project using pydoc.
My repository looks like this:
main.py
src/
├─ cli.py
├─ ui.py
In the main.py file, I have these imports:
import argparse
import ...
0
votes
1
answer
94
views
macro expand to inner attribute and inner comment
I'm trying to make some stability promises for my library. Ideally I'd like to be able to mark the top of a file as stable/unstable, and emit some things as a result.
Unstable allows unused, and is ...
0
votes
2
answers
76
views
Laravel API: PUT request with multipart/form-data returns empty request when using Swagger or Postman [duplicate]
I'm working on a Laravel 10.x project with an API that allows updating an event using a PUT /events/{id} endpoint. This endpoint accepts multipart/form-data to optionally upload an image and pdf, and ...