D
Deno

help

Two questions on documentation

Hhexagon56k2/3/2023
RTFM in 3... 2... 🙂 Question 1: How do i hide documentation for specific exports, i do not want to document exports of dependencies, like https://deno.land/x/entsoe_api_client@0.5.1/deps.ts . I tried /** @ignore */ to no avail Question 2: Is it possible to get some sort of generic description for a file, like: https://deno.land/x/entsoe_api_client@0.5.1/mod.ts , similar to the docs that appear if i click on a function, like https://deno.land/x/entsoe_api_client@0.5.1/mod.ts?s=Query
IioB2/3/2023
For number 2: I recommend looking at the docs for other modules to see how they look. I discovered that https://deno.land/std@0.176.0/archive/mod.ts has the generic description you were looking for and discovered that it did
/**
* Provides a `Tar` and `Untar` classes for compressing and decompressing
* arbitrary data.
*
* @module
*/
/**
* Provides a `Tar` and `Untar` classes for compressing and decompressing
* arbitrary data.
*
* @module
*/
to show that description. I haven't looked at #1 yet but that sounds like it would be solvable, I just haven't found a solution yet. I'm not sure if I understand #1, why do you want to hide the documentation for dependencies?
Hhexagon56k2/3/2023
Oh, cool. Will have a look at the archive module I don't think documenting the dependencies add any value (as they're not exported to be used by a third party). It just become a duplicate of the original packages documentation.
CcrowlKats2/3/2023
we currently dont have a way to disable documentation for a file
IioB2/3/2023
I think the question was
How do i hide documentation for specific exports
Which is subtly different. I feel like I remember seeing this functionality at some point but I may be completely wrong. Also this is definitely an XY problem type of question
CcrowlKats2/3/2023
ok let me be more generic: there is no way to hide documentation of any kind at all currently as far as i remember
IioB2/3/2023
Ah okay, I guess my intuition was wrong. Thanks for clarifying.
Hhexagon56k2/3/2023
Cool guys, question #2 solved, turned out pretty awesome (grammar excluded 🥸 )
/**
* Main entrypoint of entsoe_api_client.
*
* Exports all functions and interfaces that is indended for public use.
*
* @module entsoe_api_client
* @author Hexagon <hexagon@GitHub>
* @license MIT
*/
/**
* Main entrypoint of entsoe_api_client.
*
* Exports all functions and interfaces that is indended for public use.
*
* @module entsoe_api_client
* @author Hexagon <hexagon@GitHub>
* @license MIT
*/
What standard do deno doc use for typescript, is it tsdoc? I notice that types are extracted just fine when writing jsdoc without types. With that info, i could figure out a decent feature request for exclusion 🙂
CcrowlKats2/3/2023
yea, it is mostly based on tsdoc, but with additional features taken from jsdoc (as tsdoc is quite feature-lacking) its just a matter of implementing an ignore tag; should be fairly easy @iobdas maybe something you'd wanna do :P?
IioB2/3/2023
Fine. I'll look into it.
CcrowlKats2/3/2023
lol, if you dont want, dont have to
Hhexagon56k2/3/2023
😅 Thanks guys!
IioB2/3/2023
It's too late... you put me on the spot <:blob_confounded_face:1040664030001508372>
CcrowlKats2/3/2023
lol if you need any pointers, let me know

Looking for more? Join the community!

Recommended Posts
Is there any simple way to keep track of the heap/stack usage of a running Deno application?I have made a Deno application and I'm curious to know if there's heap/stack issues that I should fiusing data from one deno bench in anotheris there any good way to re-use the results generated in one deno bench in another one? example: `docker compose up of Oak server throws: SyntaxError: Duplicate export of 'type'I am just learning how to use Docker, and am trying to put up a container of an Oak server. When runPublishing Deno Module with Bin (Answered)I know there's a way to include a `bin/` when publishing a module and then perform some kind of `denUse local tgz file instead of tgz from npm registryHello, Is it possible to reference a local tgz file inside a deno project (like calling `npm instalvscode LSP being a disgraceful little bitchfor no reason obvious to me, vscode and deno's lsp has been acting up lately. any ideas what could bIs there a way to fetch() with headers, WITHOUT forcing header keys to lowercase?Title. I'm trying to create an API wrapper for a service which uses "Incapsula" as their firewall orHow do I use std/log?I'm trying to create a log file. I don't seem to be able to make it work tho. ```ts import { handleop_ffi_cstr_read replacement now that deno.core.ops is gone?The latest release removed Deno.core.ops, which a library of mine relied on to use `op_ffi_cstr_readNPM Import results in Rust panicLooking to import the Airgram NPM package because I don't want to write it from scratch at this momeDeno fmt conflicting with Deno lint, when using IIFE```ts // before formating ((): void => { /* code */ })() ``` after formating with deno fmt, it adds prototype dot functions. How?How would I go about creating dot function that can be chained at the end of a number in Deno? ExamRepublish a /x/ module from a deleted repoIs it possible to publish an old module from a new repo? i'v deleted an old one and created a new reHow to get Deno to fmt on save with VSCode?I have a deno.json file with some fmt options which works if run fromt the command line but not whenIntegrate Twin to Svelte+Vite+Deno as FreshIs there any way to integrate the use of Twind into the Stelte+Vite+Deno project as Fresh does? Thacan i render some pages as SPA and some as SSR in fresh?#fresh kanalına mesaj göndercan i render some pages as SPA and some as SSR in fresh? #fresh kanalına mesaj gönderHow can i return a base64 as file on Deno Deploy?Could someone give me an example for this?How to disable deno linter for whole project directory?I'm using deno with mixed project folders, some use Vue and shouldn't be linted by deno. How do i diHow can I get `npm` in the path for Deno.run()?I'm writing a script to automate a tedious npm task that I run frequently. When I use `Deno.run()` iUse Deno.run() to communicate with ArduinoHey I'm trying to communicate via USB serial with my Arduino. My goal is to have the result I get vi