summary refs log tree commit diff stats
path: root/doc
Commit message (Collapse)AuthorAgeFilesLines
* fixes #19396; Nimdoc hide nonexported fields (#21305)ringabout2023-02-011-0/+1
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | * suppresses non-exported fields of types and adds command-line option to re-enable this if desired * corrected the doctest that produced a CI error * an embarrassingly bad error in reasoning * modified a nimdoc test to reflect updated behavior * needed another change to bring utils.html doctest in sync with update * add info * fix nimdoc * lint * render postfix * fixes a problem * fixes nimdoc * fix nimdoc --------- Co-authored-by: johnperry-math <john.perry@usm.edu> Co-authored-by: johnperry-math <devotus@yahoo.com>
* Update nims.md to use `nim e` instead of `nim` in advanced shebang (#21301)Heechul Ryu2023-01-261-1/+1
| | | | | | Update nims.md - suggest a better shebang that works with any filename - related to https://github.com/nim-lang/Nim/issues/17190
* add `md2html`, `md2tex` to cmd helpers (#21295)ringabout2023-01-241-0/+3
|
* testament: make valgrind optional (#21238)Anna2023-01-111-0/+1
| | | Add a simple switch to enable/disable valgrind support. On by default
* docgen: implement cross-document links (#20990)Andrey Makarov2023-01-043-36/+367
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | * docgen: implement cross-document links Fully implements https://github.com/nim-lang/RFCs/issues/125 Follow-up of: https://github.com/nim-lang/Nim/pull/18642 (for internal links) and https://github.com/nim-lang/Nim/issues/20127. Overview -------- Explicit import-like directive is required, called `.. importdoc::`. (the syntax is % RST, Markdown will use it for a while). Then one can reference any symbols/headings/anchors, as if they were in the local file (but they will be prefixed with a module name or markup document in link text). It's possible to reference anything from anywhere (any direction in `.nim`/`.md`/`.rst` files). See `doc/docgen.md` for full description. Working is based on `.idx` files, hence one needs to generate all `.idx` beforehand. A dedicated option `--index:only` is introduced (and a separate stage for `--index:only` is added to `kochdocs.nim`). Performance note ---------------- Full run for `./koch docs` now takes 185% of the time before this PR. (After: 315 s, before: 170 s on my PC). All the time seems to be spent on `--index:only` run, which takes almost as much (85%) of normal doc run -- it seems that most time is spent on file parsing, turning off HTML generation phase has not helped much. (One could avoid it by specifying list of files that can be referenced and pre-processing only them. But it can become error-prone and I assume that these linke will be **everywhere** in the repository anyway, especially considering https://github.com/nim-lang/RFCs/issues/478. So every `.nim`/`.md` file is processed for `.idx` first). But that's all without significant part of repository converted to cross-module auto links. To estimate impact I checked the time for `doc`ing a few files (after all indexes have been generated), and everywhere difference was **negligible**. E.g. for `lib/std/private/osfiles.nim` that `importdoc`s large `os.idx` and hence should have been a case with relatively large performance impact, but: * After: 0.59 s. * Before: 0.59 s. So Nim compiler works so slow that doc part basically does not matter :-) Testing ------- 1) added `extlinks` test to `nimdoc/` 2) checked that `theindex.html` is still correct 2) fixed broken auto-links for modules that were derived from `os.nim` by adding appropriate ``importdoc`` Implementation note ------------------- Parsing and formating of `.idx` entries is moved into a dedicated `rstidx.nim` module from `rstgen.nim`. `.idx` file format changed: * fields are not escaped in most cases because we need original strings for referencing, not HTML ones (the exception is linkTitle for titles and headings). Escaping happens later -- on the stage of `rstgen` buildIndex, etc. * all lines have fixed number of columns 6 * added discriminator tag as a first column, it always allows distinguish Nim/markup entries, titles/headings, etc. `rstgen` does not rely any more (in most cases) on ad-hoc logic to determine what type each entry is. * there is now always a title entry added at the first line. * add a line number as 6th column * linkTitle (4th) column has a different format: before it was like `module: funcName()`, now it's `proc funcName()`. (This format is also propagated to `theindex.html` and search results, I kept it that way since I like it more though it's discussible.) This column is what used for Nim symbols resolution. * also changed details on column format for headings and titles: "keyword" is original, "linkTitle" is HTML one * fix paths on Windows + more clear code * Update compiler/docgen.nim Co-authored-by: Andreas Rumpf <rumpf_a@web.de> * Handle .md and .nim paths uniformly in findRefFile * handle titles better + more comments * don't allow markup overwrite index title for .nim files Co-authored-by: Andreas Rumpf <rumpf_a@web.de>
* make it printer friendly (#21218)Bung2023-01-041-0/+9
|
* fix #19580; add warning for bare except: clause (#21099)ringabout2022-12-152-13/+11
| | | | | | | | | | | | | | | | | | | | | * fix #19580; add warning for bare except: clause * fixes some easy ones * Update doc/manual.md * fixes docs * Update changelog.md * addition * Apply suggestions from code review Co-authored-by: Jacek Sieka <arnetheduck@gmail.com> * Update doc/tut2.md Co-authored-by: Jacek Sieka <arnetheduck@gmail.com>
* generic `define` pragma + string alias (#20979)metagn2022-12-132-0/+41
| | | | | | | | | * generic `define` pragma + string alias * clean * add tests and document * remove char/float, minimize changelog
* alternative, much simpler algorithm for strict func checking (#21066)Andreas Rumpf2022-12-111-10/+6
| | | | | | | | | | | | | * alternative, much simpler algorithm for strict func checking * forgot to git add new compiler module * new spec is incredibly simple to describe * fixes bigints regression * typos * closes #16305; closes #17387; closes #20863
* clean up the documentation of threads (#21067)ringabout2022-12-101-12/+1
| | | | | * clean up the documentation of threads * cleanup
* fix issue #20922 by handling missing expr in `exprList` for `tkOf` (#20930)Vindaar2022-12-081-3/+4
| | | | | | | | | | | | | | | | | | * fix issue #20922 by handling missing expr in `exprList` for `tkOf` * fix line numbers in test case * rewrite exprList requiring expr, add optionalExprList for except As suggested by @metagn. * update test case to reflect new code * update grammar.txt * update line numbers in test case taking into account nimout Given the number of errors that are produced it seems easier to do it this way instead of using `tt.Error`.
* Mention toSet in the docs of the set type (#21037)Xavier Noria2022-12-081-0/+8
|
* fixes #16656; add nre to lib.md (#21042)ringabout2022-12-081-0/+4
|
* fixes `strictnotnil` documentation; comment unfinished sections (#21041)ringabout2022-12-081-6/+9
| | | fixes documentation; comment unfinished sections
* build the documentation of official packages (#20986)ringabout2022-12-061-0/+4
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | * remove db stuffs * remove punycode * remove * fixes script * add cloner * patches * disable * patch * fixes external packages * disable two packages * preview documentation build * try again * fixes URL * fixes a bug * simplify * fixes documentaion * fixes * Apply suggestions from code review
* Named arguments in commands + many grammar fixes (#20994)metagn2022-12-061-21/+30
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | * Breaking parser changes, implement https://github.com/nim-lang/RFCs/issues/442 Types are separated from expressions and better reflected in the grammar. * add test * more accurate grammar * fix keyword typedescs * accept expressions in proc argument lists * CI "fixes" * fixes * allow full ref expressions again, adapt old tests * cleanup, fix some tests * improve grammar, try and revert semtypes change * restrict sigil binding to identOrLiteral * fix, should have caught this immediately * add changelog entry, fix double not nil bug * correct grammar * change section * fix * real fix hopefully * fix test * support LL(1) for tuples * make grammar.txt too
* definite assignment analysis for let (#21024)ringabout2022-12-061-0/+14
| | | | | | | | | | | | | | | | | | | * draft for let daa * patch * fixes bugs * errors for global let variable reassignments * checkpoint * out param accepts let * add more tests * add documentation * merge tests
* stdlib organization & documentation improvements (#20971)metagn2022-12-062-40/+133
| | | | | | | | | | | | | | | | | * 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>
* Add: missing nintendo-switch define (#21009)Dmitry Arkhipenko2022-12-051-0/+1
|
* better procvar ambiguity errors, clean up after #20457 (#20932)metagn2022-12-011-0/+17
| | | | | | | | | | | | | | | * better procvar ambiguity errors, clean up after #20457 fixes #6359, fixes #13849 * only trigger on closedsymchoice again * new approach * add manual entry for ambiguous enums too * add indent [skip ci] * move to proc
* move `smtp` to nimble packages (#20953)ringabout2022-11-301-3/+0
| | | | | | | | | * move `smtp` to nimble packages * fixes * install smtp * yes
* fixes documentation regression (#20960)ringabout2022-11-291-1/+1
| | | follow up https://github.com/nim-lang/Nim/pull/20371
* Correct descriptions for oids (#20926)ringabout2022-11-261-2/+1
|
* add documentation and changelog for default object fields (#20845)ringabout2022-11-151-0/+51
|
* fix a few "broken link" warnings (#20837)Andrey Makarov2022-11-141-1/+1
|
* fixes documentation regression and a bit clean up (#20793)ringabout2022-11-091-9/+7
| | | | | | | | | * fixes documentation regression and a bit clean up follow up https://github.com/nim-lang/Nim/pull/20371 * Apply suggestions from code review * Apply suggestions from code review
* Update testament docs demo, command output, and gotchas (#20756)Lee Matos2022-11-051-20/+29
|
* removes channels_builtin when enabling `nimPreviewSlimSystem` (#20713)ringabout2022-10-311-4/+0
|
* add back discard as a way to do multiline comments, see #12352 (#20688)Pietro Peterlongo2022-10-281-0/+12
|
* implemented strictCaseObjects (#20608)Andreas Rumpf2022-10-211-0/+36
| | | | | * implemented strictCaseObjects * changelog update
* [`std/os` clean up] import and export `osseps` (#20580)ringabout2022-10-171-1/+1
| | | import and export osseps
* fixes #19162; enable `strictEffects` for v2 (#19380)ringabout2022-10-151-3/+1
| | | | | | | | | | | | | | | | | | | * enable stricteffects * add gcsafe * fix tests * use func * fixes pegs tests * explicitly mark repr related procs with noSideEffect * add nimLegacyEffects * change URL * fixes docopt * add `raises: []` to repr * fixes weave * fixes nimyaml * fixes glob * fixes parsetoml * Apply suggestions from code review * Update testament/important_packages.nim * add legacy:laxEffects
* 'lock levels' are deprecated, now a noop (#20539)ringabout2022-10-111-99/+0
| | | | | * 'lock levels' are deprecated, now a noop * fixes tests
* update the maintained repo of ast-pattern-matching (#20537)ringabout2022-10-101-1/+1
|
* Automatic dereferencing is removed (#20531)ringabout2022-10-102-27/+0
|
* DAA and 'out' parameters (#20506)Andreas Rumpf2022-10-061-3/+129
| | | | | | | | | | | * DAA and 'out' parameters * progress * documented strictDefs and out parameters * docs, tests and a bugfix * fixes silly regression
* correct grammar (ref #20199) and add check for grammar.txt (#20494)ringabout2022-10-061-2/+1
| | | | | | | * correct grammar; ref #20199 * add check for keeping grammar.txt up-to-date * add nimTestGrammar
* follow up #20109; remove `shallow` seqs/strings for ORC (#20502)ringabout2022-10-061-14/+0
| | | | | | | * remove `shallow` seqs/strings for ORC * add a changelog item * change url of DelaunayNim
* Markdown indented code blocks (#20473)Andrey Makarov2022-10-0520-562/+597
| | | | | | | | | | | | | | | | | | | | | | | * Implement Markdown indented code blocks Additional indentation of 4 spaces makes a block an "indented code block" (monospaced text without syntax highlighting). Also `::` RST syntax for code blocks is disabled. So instead of ```rst see:: Some code ``` the code block should be written as ```markdown see: Some code ``` * Migrate RST literal blocks :: to Markdown's ones
* add default field support for object in ARC/ORC (#20480)ringabout2022-10-041-1/+1
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | * fresh start * add cpp target * add result support * add nimPreviewRangeDefault * reduce * use orc * refactor common parts * add tuple support * add testcase for tuple * cleanup; fixes nimsuggest tests * there is something wrong with cpp * remove * add support for seqs * fixes style * addd initial distinct support * remove links * typo * fixes tuple defaults * add rangedefault * add cpp support * fixes one more bugs * add more hasDefaults * fixes ordinal types * add testcase for #16744 * add testcase for #3608 * fixes docgen * small fix * recursive * fixes * cleanup and remove tuple support * fixes nimsuggest * fixes generics procs * refactor * increases timeout * refactor hasDefault * zero default; disable i386 * add tuples back * fixes bugs * fixes tuple * add more tests * fix one more bug regarding tuples * more tests and cleanup * remove messy distinct types which must be initialized by original types * add tests * fixes zero default * fixes grammar * fixes tests * fixes tests * fixes tests * fixes comments * fixes and add testcase * undo default values for results Co-authored-by: flywind <43030857+xflywind@users.noreply.github.com>
* Unicode Operators are no longer experimental (#20444)ringabout2022-09-282-21/+15
| | | | | | | | | * Unicode Operators are no longer experimental * fixes tests * Update doc/manual.md Co-authored-by: Andreas Rumpf <rumpf_a@web.de>
* moderate system cleanup & refactor (#20355)metagn2022-09-281-11/+0
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | * system refactor, move out 600 lines * compilation, slice, backwardsindex, misc_num moved out of system * some procs/types moved into arithmetics, basic_types * system no longer depends on syncio * some procs moved around to fit with their surroundings * make exceptions an import, old ops to misc_num * move instantiationInfo back * move back nim version, fix windows echo * include compilation * better docs for imported modules, fix unsigned ops also remove ze, ze64, toU8, toU16, toU32 with nimPreviewSlimSystem * fix terminal * workaround IC test & weird csize bug, changelog * move NimMajor etc back to compilation, rebase for CI * try ic fix * form single `indices`, slim out TaintedString, try fix IC * fix CI, update changelog, addQuitProc * fix CI * try fix CI * actually fix CI finally hopefully * Update lib/system/compilation.nim Co-authored-by: ringabout <43030857+ringabout@users.noreply.github.com> * update kochdocs * hopefully fix csize uses for slimsystem * fix tquit Co-authored-by: ringabout <43030857+ringabout@users.noreply.github.com>
* remove deprecated and broken nimweb tools (#20442)ringabout2022-09-281-5/+1
| | | | | * remove deprecated and broken nimweb tools * readme
* add a changelog and update the document for ORC (#20415)ringabout2022-09-262-11/+9
| | | | | | | | | | | | | | | | | | | | * add a changelog and update the document for ORC * hone * back * Apply suggestions from code review Co-authored-by: Clay Sweetser <Varriount@users.noreply.github.com> * Update doc/mm.md Co-authored-by: Clay Sweetser <Varriount@users.noreply.github.com> * Update doc/mm.md Co-authored-by: Clay Sweetser <Varriount@users.noreply.github.com> Co-authored-by: Andreas Rumpf <rumpf_a@web.de>
* Extract markdown/rst doc into separate file (#20404)Andrey Makarov2022-09-222-26/+263
| | | | | | | | | | | * Extract Markdown & Rst doc into separate file This documentation should be extracted into separate file as it's user's documentation, which can be used as a separate utility for compiling `.md/.rst` files. * Restructure: move markup info into markdown_rst.md +Markdown link migration
* Update manual.md (#20394)Judd2022-09-211-17/+18
| | | | | | | | | | | | | | | | | | | | | | | | | | * Update manual.md update outdated information on `ObservableStores`. * Update manual.md add `base` pragma to fix the warning. * Update doc/manual.md accept. Co-authored-by: Clay Sweetser <Varriount@users.noreply.github.com> * Update manual.md update example code. * Update manual.md 1. more updates to help keeping readers on track. 1. fix typos. Co-authored-by: Clay Sweetser <Varriount@users.noreply.github.com>
* Markdown link migration part 2 (#20371)Andrey Makarov2022-09-1918-284/+288
|
* more minor updates to manual.md (#20360)Judd2022-09-151-5/+5
| | | | | | | | | | * fix typos in manual.md 1. remove redundant `(` 1. 'System module' -> 'system module'. * Update manual.md "However" is not easy to understand. Suggest changing to the word into "In this version" to make the comparison explicite.
* minor improvements to follow up recent PRs (#20342)metagn2022-09-142-38/+32
| | | | | | put mOpenArrayToSeq in compile-time evaluation whitelist (it was mNone before which was whitelisted), homogenize "ordinal type expected" errors, put overloadable enums in non-experimental manual
* nimgrep: add `--inContext` and `--notinContext` options (#19528)Andrey Makarov2022-09-142-32/+103
| | | | | | | | | | | | | | | | | | | | | | | | | | * nimgrep: add `--matchContext` and `--noMatchContext` options * Rename options for uniformity * Revise option names, add `--parentPath` options * Revert --bin deprecation * Copy-paste an original test from quantimnot The origin was: https://gist.githubusercontent.com/quantimnot/5d23b32fe0936ffc453220d20a87b9e2/raw/96544656d52332118295e55aa73718c389e5d194/tnimgrep.nim * Change ! to n * Attempt to fix test * Fix test on Windows * Change --contentsFile -> --inFile, add more tests * Bump * Change --parentPath to --dirpath
generated by cgit-pink 1.4.1-2-gfad0 (git 2.36.2.497.gbbea4dcf42) at 2025-02-08 07:17:50 +0000