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

"Test" module is documented as a type #3686

Open
Altai-man opened this issue Nov 3, 2020 · 4 comments
Open

"Test" module is documented as a type #3686

Altai-man opened this issue Nov 3, 2020 · 4 comments
Assignees
Labels
docs Documentation issue (primary issue type) external Depends on another ticket (likely in another repo)

Comments

@Altai-man
Copy link
Member

Problem or new feature

(this is more a ticket for myself, so no hurry)

We have documented type (again, type) "Test" at https://docs.raku.org/type/Test which actually talks about a module, which is really odd to have it placed there, since no such type exists in Raku language.

Suggestions

1)Once we have a website, place a nice hand-crafted redirect.
2)To move this page somewhere where it belongs, somewhere in "Language" section.

@Altai-man Altai-man added docs Documentation issue (primary issue type) external Depends on another ticket (likely in another repo) labels Nov 3, 2020
@Altai-man Altai-man self-assigned this Nov 3, 2020
@coke
Copy link
Collaborator

coke commented Nov 3, 2020

Good Catch! https://docs.raku.org/type.html shows it's the only module listed in with the types, and https://docs.raku.org/language/nativecall shows the other module we include.

@Altai-man
Copy link
Member Author

Yup. I noticed that when generating type categories for index pages and noticed some of them specified in actual pod files (notably "metamodel" and "module") are not specified in config.json, thus not present in menu etc.
Anything once we can handle sane redirecting with fast page serving...

@JJ
Copy link
Contributor

JJ commented Nov 4, 2020

There's no such thing as a module in the index; they're all "Types". Nativecall lacks a a proper "type" page, which is basically why it's not there. That was a judgement call, I guess. "Types" and "Language" follow different indexing rules, for once; "Types" are expected to have methods, subs and so on; also Language pages don't get loaded up with graphs and superclass methods. If I had to point out an error, that would be Nativecall being only in Language and not in Types. But the word "types" was chosen before Test and Nativecall were decided to be included there. A change of stub name is, for the time being, out of question (besides, what would that be? packages?). But clarifying that "types" refers to "types, modules, and also a few routines that don't go in any of them -- that would be independent-routines" is probably in order.

@JJ
Copy link
Contributor

JJ commented Nov 4, 2020

Come to think of it, modules don't really need the addition of supertypes or type graph. So maybe it should have some special treatment.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs Documentation issue (primary issue type) external Depends on another ticket (likely in another repo)
Projects
None yet
Development

No branches or pull requests

3 participants