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

Added note about imports where necessary #13026

Merged
merged 4 commits into from
Feb 13, 2023
Merged

Added note about imports where necessary #13026

merged 4 commits into from
Feb 13, 2023

Conversation

Tamnac
Copy link
Contributor

@Tamnac Tamnac commented Jan 29, 2023

Closes #12936

I tried my best to figure out the appropriate thing to import, but it turned out more complicated than expected, so may not be perfect.

Uses a NOTE in the overview section of each page.

src/big/big_float.cr Outdated Show resolved Hide resolved
src/colorize.cr Show resolved Hide resolved
src/ecr.cr Show resolved Hide resolved
src/log.cr Outdated Show resolved Hide resolved
src/yaml.cr Outdated Show resolved Hide resolved
@Tamnac
Copy link
Contributor Author

Tamnac commented Jan 30, 2023

I believe that's it. I must've forgotten to check YAML.

@straight-shoota straight-shoota added this to the 1.8.0 milestone Feb 10, 2023
@straight-shoota straight-shoota added this pull request to the merge queue Feb 13, 2023
Merged via the queue into crystal-lang:master with commit 9c2cd84 Feb 13, 2023
@Sija
Copy link
Contributor

Sija commented Feb 13, 2023

I'd rather use term require, since import is sth non-existent in Crystal, so far and it could be easily mistaken with import features in other languages, which are quite different.

@Tamnac
Copy link
Contributor Author

Tamnac commented Feb 13, 2023

I avoided repeating "require" since that's awkward phrasing, and "include" is already a keyword. I can make another pr though if you say so, since it seems this one was merged by mistake.

@HertzDevil
Copy link
Contributor

The terminology is appropriate though, since you only require a file, not a type.

@straight-shoota
Copy link
Member

Thanks for raising this issue. But I think it's okay.
The exact term is not critical.

@Sija
Copy link
Contributor

Sija commented Feb 13, 2023

The terminology is appropriate though, since you only require a file, not a type.

@HertzDevil Yeah, but the word in question is import.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Indicate in documentation when something has to imported via require
5 participants