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

docgen doesn't create links for certain symbols #10487

Closed
3 of 4 tasks
timotheecour opened this issue Jan 29, 2019 · 1 comment
Closed
3 of 4 tasks

docgen doesn't create links for certain symbols #10487

timotheecour opened this issue Jan 29, 2019 · 1 comment
Labels
Documentation Generation Related to documentation generation (but not content). Feature

Comments

@timotheecour
Copy link
Member

timotheecour commented Jan 29, 2019

I really like the new feature introduced by @Araq in 13d667e (docgen: produce links for proc names).

it doesn't work in some cases eg:

in https://nim-lang.github.io/Nim/osproc.html

  • Process = ref ProcessObj => no link for ProcessObj
  • no link for enum elements eg: poStdErrToStdOut here:
proc startCmd(command: string;
             options: set[ProcessOption] = {poStdErrToStdOut, poUsePath}): Process
  • no links for symbols inside a runnableExamples block (this one is more controversial but would be nice IMO):
    (non runnableExamples code block may be impossible as it's not guaranteed to be runnable, but runnableExamples should be)
var t = {"name": "John", "city": "Monaco"}.newStringTable
doAssert "${name} lives in ${city}" % t == "John lives in Monaco"

[EDIT]

@timotheecour timotheecour added the Documentation Generation Related to documentation generation (but not content). label Jan 29, 2019
@Araq Araq added the Feature label Jan 29, 2019
narimiran added a commit to narimiran/Nim that referenced this issue Mar 19, 2019
Araq pushed a commit that referenced this issue Mar 20, 2019
* docgen: add links for var, let and const (refs #10487)

* change the expected html
@narimiran
Copy link
Member

Two and a half raised points are fixed (with half being: there's no link for enum elements, but in the example options: set[ProcessOption] = {poStdErrToStdOut, poUsePath}: ProcessOption is clickable and there you can see each enum element).

The remaining point (links in runnableExamples) is, as stated, "more controversial but would be nice", and I don't see enough ROI in it. Therefore, I consider this issue to be fixed.

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

No branches or pull requests

3 participants