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

docs: empty version picker on some pages #15396

Closed
chris--young opened this issue Sep 13, 2017 · 3 comments
Closed

docs: empty version picker on some pages #15396

chris--young opened this issue Sep 13, 2017 · 3 comments
Labels
doc Issues and PRs related to the documentations. wip Issues and PRs that are still a work in progress.

Comments

@chris--young
Copy link

  • Version: 8.5.0
  • Platform: n/a
  • Subsystem: n/a

The version picker I added to the docs recently does not properly account for pages without the <-- introduced_in --> tag, or pages with the tag but without multiple version of the doc. The n-api docs are a good example of this. The version drop down is there, but has no options when you click on it.

Affected pages: async_hooks, n-api, deprecations, esm, http2, inspector, intl, perf_hooks, tracing

I already started working on a fix for this and will open a pr later tonight.

@mscdex mscdex added the doc Issues and PRs related to the documentations. label Sep 13, 2017
chris--young pushed a commit to chris--young/node that referenced this issue Sep 14, 2017
@refack refack added the wip Issues and PRs that are still a work in progress. label Sep 14, 2017
@refack
Copy link
Contributor

refack commented Sep 14, 2017

@chris--young what's you idea for solution? Intuitively I'd go with a "available in current version only" (or something similar) placeholder instead of the drop down.

P.S. How much work would it be to add minor versions as well (maybe only relevant minor when new feature were added based on the added YAML tag). For example 😉

node/doc/api/n-api.md

Lines 3400 to 3408 in cb94905

### napi_adjust_external_memory
<!-- YAML
added: v8.5.0
-->
```C
NAPI_EXTERN napi_status napi_adjust_external_memory(napi_env env,
int64_t change_in_bytes,
int64_t* result);
```

@chris--young
Copy link
Author

@refack the change i have now just doesnt display the drop down at all if there arent multiple version to pick from.

including minor version should be doable but it will probably take a bit more work. i think itd be best to do that in a separate pr so it doesnt block fixing this bug

@refack
Copy link
Contributor

refack commented Sep 15, 2017

@refack the change i have now just doesnt display the drop down at all if there arent multiple version to pick from.

including minor version should be doable but it will probably take a bit more work. i think itd be best to do that in a separate pr so it doesnt block fixing this bug

Agreed.

jasnell pushed a commit that referenced this issue Sep 20, 2017
PR-URL: #15420
Fixes: #15396
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Refael Ackermann <refack@gmail.com>
Reviewed-By: Evan Lucas <evanlucas@me.com>
Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>
Qard pushed a commit to Qard/ayo that referenced this issue Sep 21, 2017
PR-URL: nodejs/node#15420
Fixes: nodejs/node#15396
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Refael Ackermann <refack@gmail.com>
Reviewed-By: Evan Lucas <evanlucas@me.com>
Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>
chris--young pushed a commit to chris--young/node that referenced this issue Sep 29, 2017
PR-URL: nodejs#15420
Fixes: nodejs#15396
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Refael Ackermann <refack@gmail.com>
Reviewed-By: Evan Lucas <evanlucas@me.com>
Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>
MylesBorins pushed a commit that referenced this issue Sep 29, 2017
Backport-PR-URL: #15670
PR-URL: #15420
Fixes: #15396
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Refael Ackermann <refack@gmail.com>
Reviewed-By: Evan Lucas <evanlucas@me.com>
Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>
addaleax pushed a commit to addaleax/ayo that referenced this issue Oct 12, 2017
PR-URL: nodejs/node#15420
Fixes: nodejs/node#15396
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Refael Ackermann <refack@gmail.com>
Reviewed-By: Evan Lucas <evanlucas@me.com>
Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
doc Issues and PRs related to the documentations. wip Issues and PRs that are still a work in progress.
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants