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.

Sign up for GitHub

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

Jump to bottom

Experimental features in normal manual instead of experimental manual/undocumented #19162

Closed
metagn opened this issue Nov 17, 2021 · 2 comments · Fixed by #19380
Closed

Experimental features in normal manual instead of experimental manual/undocumented #19162

metagn opened this issue Nov 17, 2021 · 2 comments · Fixed by #19380
Labels
Documentation Content Related to documentation content (not generation). Severe

Comments

@metagn
Copy link
Collaborator

metagn commented Nov 17, 2021 •
edited
Loading

The experimental features compiletimeFFI, dynamicBindSym and vmopsDanger are not documented in the experimental manual as of 1.6.0 (full list). Since vmopsDanger seems to do very little and compiletimeFFI seems to be unfinished, I'm not sure if they need to be documented. dynamicBindSym is documented in macros.bindSym and in 0.19 changelog however, which may be enough.

However the following experimental features are documented in the regular manual instead of the experimental manual. Don't know if this is intended.

Update: Since #19173, only compiletimeFFI and vmopsDanger are not documented, and strictEffects is still in the regular manual, because it may eventually leave experimental status.
@beef331
Copy link
Collaborator

beef331 commented Nov 17, 2021

I think you missed strict not nil in the manual

@metagn metagn changed the title Undocumented experimental features Experimental features in normal manual instead of experimental manual/undocumented Nov 18, 2021
@metagn
Copy link
Collaborator Author

metagn commented Nov 18, 2021 •
edited
Loading

I swear it wasn't there when I checked, multiple times. Now there's no concrete issue, except that maybe the 1.6 experimental features should be in the experimental manual instead of the normal manual, which I'm not even sure is a mistake, or maybe some of the undocumented obscure experimental features should be documented.

@Araq Araq added Severe Documentation Content Related to documentation content (not generation). labels Nov 18, 2021
@metagn metagn mentioned this issue Nov 22, 2021
Merged
@ringabout ringabout mentioned this issue Oct 7, 2022
Merged
11 tasks
Araq pushed a commit that referenced this issue Oct 15, 2022
@ringabout
fixes #19162; enable strictEffects for v2 (#19380)
1e15f97 
* 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
capocasa pushed a commit to capocasa/Nim that referenced this issue Mar 31, 2023
@ringabout @capocasa
fixes nim-lang#19162; enable strictEffects for v2 (nim-lang#19380)
8832aea 
* 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
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
Documentation Content Related to documentation content (not generation). Severe
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

fixes #19162; enable strictEffects for v2 ringabout/Nim
3 participants
@Araq @metagn @beef331