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

stdlib organization & documentation improvements #20971

Merged
merged 7 commits into from
Dec 6, 2022

Conversation

metagn
Copy link
Collaborator

@metagn metagn commented Nov 29, 2022

asyncmacro is converted to an import/export in asyncdispatch instead of an include, since async imports asyncmacro as well. This seems to work without extra changes?

jsfetch now exports jsformdata and jsheaders to reduce burden on users.

The following modules are added to doc/lib.md (note that some of these have messages like "unstable API" or "experimental", but these messages have been there for years, and some modules already in doc/lib.md have them as well):

  • compilesettings, effecttraits (core)
  • formatfloat*, objectdollar*, widestrs* (strings)
  • reservedmem, exitprocs*, syncio*, appdirs**, cmdline**, dirs**, envvars**, files**, oserrors**, paths**, symlinks** (generic OS services)
  • async, asyncmacro, socketstreams (internet protocols)
  • isolation, tasks, typedthreads* (threading)
  • genasts (generators)
  • decls, importutils, wrapnils, assertions* (miscellaneous)
  • jsfetch, jsre (javascript)
  • db_odbc (database)
    * part of nimPreviewSlimSystem
    ** part of os module splitup

The following modules have changed sections:

  • lenientops (core -> math)
  • ropes, strtabs (strings -> collections)
  • parseutils, pegs (strings -> parsers)
  • marshal (generic OS services -> serialization (new section))
  • jsonutils (parsers -> serialization (new section))

The following deprecated modules have been removed from documentation and moved to lib/deprecated/pure:

  • sums (moved to nimble package)
  • mersenne (graveyard)
  • oswalkdir

The following modules have not been included in doc/lib.md for various reasons:

  • jsformdata, jsheaders (essentially submodules of jsfetch)
  • pathnorm (seems dubious)
  • chains (too small/seems internal)
  • experimental/diff (seems internal)
  • rtarrays (says "not ready for other people to use")
  • outparams (tied to experimental feature and seems temporary)
  • prelude (non-essential, tiny module that has to be included to use)
  • ssl_certs/ssl_config (are these useful for other people?)
  • streamwrapper (straight up don't understand this module, it's internally used by osproc)
  • sysatomics (deprecated in place of std/atomics which is included)

If you have any objections, please say so.

doc/lib.md Outdated Show resolved Hide resolved
@Araq Araq merged commit 739e1ba into nim-lang:devel Dec 6, 2022
@github-actions
Copy link
Contributor

github-actions bot commented Dec 6, 2022

Thanks for your hard work on this PR!
The lines below are statistics of the Nim compiler built from 5d46968

Hint: mm: orc; opt: speed; options: -d:release
165507 lines; 8.028s; 612.203MiB peakmem

survivorm pushed a commit to survivorm/Nim that referenced this pull request Feb 28, 2023
* stdlib organization & documentation improvements

* fix CI

* Update doc/lib.md

Co-authored-by: Juan Carlos <juancarlospaco@gmail.com>

* fix ci, remove jshttpcore, export in jsfetch instead

* fix alphabetical order violations

* add cmdline, db_odbc

Co-authored-by: Juan Carlos <juancarlospaco@gmail.com>
capocasa pushed a commit to capocasa/Nim that referenced this pull request Mar 31, 2023
* stdlib organization & documentation improvements

* fix CI

* Update doc/lib.md

Co-authored-by: Juan Carlos <juancarlospaco@gmail.com>

* fix ci, remove jshttpcore, export in jsfetch instead

* fix alphabetical order violations

* add cmdline, db_odbc

Co-authored-by: Juan Carlos <juancarlospaco@gmail.com>
bung87 pushed a commit to bung87/Nim that referenced this pull request Jul 29, 2023
* stdlib organization & documentation improvements

* fix CI

* Update doc/lib.md

Co-authored-by: Juan Carlos <juancarlospaco@gmail.com>

* fix ci, remove jshttpcore, export in jsfetch instead

* fix alphabetical order violations

* add cmdline, db_odbc

Co-authored-by: Juan Carlos <juancarlospaco@gmail.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants