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

"import" is under-documented #2364

Open
arnesom opened this issue Oct 7, 2018 · 3 comments
Open

"import" is under-documented #2364

arnesom opened this issue Oct 7, 2018 · 3 comments
Labels
docs Documentation issue (primary issue type) RFE Request for enhancement. Try to use alternative wording that explain the concept more clearly update part of "docs" - indicates this is an update for an existing section; rewrite, clarification, etc.

Comments

@arnesom
Copy link

arnesom commented Oct 7, 2018

The "import" function isn't documented.

Default import options are not documented either: :DEFAULT and :ALL are mentioned but not indexed, for instance.

Suggestions

Add it to: https://docs.perl6.org/language/modules

@JJ
Copy link
Contributor

JJ commented Oct 7, 2018

It's documented here and indexed; just check it typing "import" in the search slot. Is that what you were looking for?

@arnesom
Copy link
Author

arnesom commented Oct 7, 2018

Sorry if i was unclear.

I meant that it hasn't a section (header) of its own. It is just mentioned in passing.

Also: "use" is explained as a combination of "need" and "import". The first is a link, and
the second isn't. I think it should be.

Ref. https://docs.perl6.org/language/modules#index-entry-use

@JJ JJ added docs Documentation issue (primary issue type) update part of "docs" - indicates this is an update for an existing section; rewrite, clarification, etc. labels Oct 8, 2018
@JJ
Copy link
Contributor

JJ commented Oct 8, 2018

There was a unaddressed (and not marked with TODO) comment in packages to add it. I have added to #2277

@JJ JJ changed the title "import" not documented "import" is under-documented May 2, 2019
@JJ JJ added the RFE Request for enhancement. Try to use alternative wording that explain the concept more clearly label May 2, 2019
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) RFE Request for enhancement. Try to use alternative wording that explain the concept more clearly update part of "docs" - indicates this is an update for an existing section; rewrite, clarification, etc.
Projects
None yet
Development

No branches or pull requests

2 participants