Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Modules not linked in the main stdlib documentation #16656

Closed
14 tasks done
konsumlamm opened this issue Jan 9, 2021 · 10 comments · Fixed by #21042
Closed
14 tasks done

Modules not linked in the main stdlib documentation #16656

konsumlamm opened this issue Jan 9, 2021 · 10 comments · Fixed by #21042
Labels
Documentation Content Related to documentation content (not generation). Easy

Comments

@konsumlamm
Copy link
Contributor

konsumlamm commented Jan 9, 2021

Summary

Looking at the index, there are quite a few modules that are not linked from the main stdlib documentation (https://nim-lang.github.io/Nim/lib.html):

Most of them seem to be internal/experimental/unstable (note that some unstable modules are nevertheless linked), but some look like they should be linked from the main stdlib documentation page, for example:

Is there a reason they aren't linked? Are there more modules that should be linked? And perhaps there are some modules that are currently linked, but shouldn't be (like intsets)?

Related issue: #16046.

Possible solution

I'd be willing to create a PR to link all the missing modules.

As mentioned in the linked issue, while generating the documentation, one could automatically check that all modules are linked. For modules that are not supposed to be linked (internal, experimental, deprecated or unstable modules), there could be a way (a pragma or a special comment?) to mark them as such. Alternatively, they could be linked in a separate section ("Internal modules").

@metagn
Copy link
Collaborator

metagn commented Jan 9, 2021

io and assertions are submodules of the system module

@konsumlamm
Copy link
Contributor Author

io and assertions are submodules of the system module

I'm aware, but so are channels and threads, or are these different (other than only being available with --threads:on)? I think they should be linked at the top level anyway, since the system module is not necessarily where I would expect these things (when starting with Nim, I couldn't find anything related to File IO iirc). I'd still put them in the "Automatic imports" section of course, to make it clear that they're part of the system module. Though I'd also be fine with keeping them only being linked from the system docs.

@juancarlospaco
Copy link
Collaborator

Send PR maybe...

@ghost ghost added the Documentation Content Related to documentation content (not generation). label Mar 18, 2021
@ghost
Copy link

ghost commented Mar 18, 2021

There's quite a lot of modules that are nowhere to be found in https://nim-lang.github.io/Nim/lib.html, for example quite a lot of modules from https://github.com/nim-lang/Nim/tree/devel/lib/std

@AFaurholt
Copy link
Contributor

I noticed rdstdin was missing

@iacore
Copy link
Contributor

iacore commented Mar 26, 2022

Also missing:

@konsumlamm
Copy link
Contributor Author

konsumlamm commented Mar 26, 2022

Also missing:

@locriacyber it's linked here: https://nim-lang.github.io/Nim/lib.html#wrappers-unix-specific.

@iacore
Copy link
Contributor

iacore commented Mar 26, 2022

Not searchable, not in "The Index" in 1.6.4. Try searching "fork".

@konsumlamm
Copy link
Contributor Author

That's not what this issue is about though (it's about modules linked from https://nim-lang.github.io/Nim/lib.html). The index apparently not including the posix module seems to be a different issue, I'd suggest opening a new issue for it.

@Araq
Copy link
Member

Araq commented Mar 27, 2022

It's not a bug, we want the index to contain useful information and not the Posix API. You're not supposed to use the Posix APIs unless you know what you're doing and in that case, you don't need the index.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Documentation Content Related to documentation content (not generation). Easy
Projects
None yet
Development

Successfully merging a pull request may close this issue.

7 participants