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

Second part of entries cleanup #743

Merged
merged 2 commits into from Jul 26, 2016
Merged

Second part of entries cleanup #743

merged 2 commits into from Jul 26, 2016

Conversation

Altai-man
Copy link
Member

According to #728 discussion, this is a patch that removes glossary items which just point to wikipedia pages.

Should we remove them or not is still a debatable question, so don't merge this "Just because".

Opinions are still needed.

@AlexDaniel
Copy link
Member

AlexDaniel commented Jul 22, 2016

Well, I think that trying to create an alternative encyclopedia of commonly used IT terms just makes no sense, so I am all for it (as you might have guessed, given my #728 report).

However, could I ask you to work a bit more on this pull request?

  • Given that you're removing Class, and given that you touched the L<class|#Class> link, you should instead change L<class|#Class>, L<module|#Module>, L<grammar|#Grammar> to point to appropriate places in the docs. For example, https://docs.perl6.org/language/objects#Classes, https://docs.perl6.org/language/modules and https://docs.perl6.org/language/grammars (or maybe there are better links, check it out yourself).
  • L<#Javascript>. assumes that we have a Javascript item – another term that we should not explain. Totally makes sense to remove it under this pull request. We do not have a description for Javascript anyway.
  • There is also a link to L<#VM>, but we only have L<#Virtual Machine>. Can we also get rid of “Virtual Machine” definition? For example, it claims that Javascript is a virtual machine… (what? Am I reading this correctly?)
  • whitespace is listed but has no description. If one can write a description that will justify its existence – great! Until then, let's assume that one can find https://en.wikipedia.org/wiki/Whitespace_character. Actually, we can also make https://docs.perl6.org/language/5to6-nutshell.html#Whitespace searchable, as it gives a good idea of what whitespace is.
  • What about Lexing?

Also, have you tried grepping for these terms in the rest of the docs? We don't really want more broken links.

@Altai-man
Copy link
Member Author

Altai-man commented Jul 22, 2016

1.Its already fixed with f96c6a1
2.Its already fixed with the same commit.
3.In this commit I changed it from #VM to #Virtual machine. We can remove it completely in this PR, I think.
4.I'll add commit that removes whitespace changes links to 5to6-nutshell too, if you think it's appropriate.
5.Who knows.

Yes, I check it with
grep -r "/language/glossary#" doc/*
Current output is:

doc/Language/contributors.pod6:L<Pull Request|/language/glossary#Pull_Request> with the required change(s).
doc/Language/5to6-nutshell.pod6:C<no warnings> is currently L<NYI|/language/glossary#NYI>,
doc/Language/performance.pod6:Use the C<m: your code goes here> L<#perl6 channel evalbot|/language/glossary#camelia>
doc/Language/performance.pod6:Enter C<prof-m: your code goes here> in the L<#perl6 channel|/language/glossary#IRC>
doc/Language/performance.pod6:others using the L<#perl6|/language/glossary#IRC> evalbot
doc/Language/performance.pod6:L<camelia|/language/glossary#camelia>.
doc/Language/variables.pod6:Note: Slangs are L<NYI|/language/glossary#NYI> in Rakudo.
doc/Type/Str.pod6:attempt to construct the appropriate L<allomorph|/language/glossary#Allomorph>,
doc/Type/NumStr.pod6:The dual value types (often referred to as L<allomorphs|/language/glossary#Allomorph>)
doc/Type/IntStr.pod6:The dual value types (often referred to as L<allomorphs|/language/glossary#Allomorph>)
doc/Type/ComplexStr.pod6:The dual value types (often referred to as L<allomorphs|/language/glossary#Allomorph>)
doc/Type/RatStr.pod6:The dual value types (often referred to as L<allomorphs|/language/glossary#Allomorph>)

We have allomorph, NYI and IRC stuff described, so I'm assuming it's safe.

By the way, it's only Glossary page uses it's own terms a lot, that's why it took me a bit of work to clean up all links there.

@AlexDaniel
Copy link
Member

AlexDaniel commented Jul 22, 2016

Right. OK, good to go then.

Opinions?

@jonathanstowe
Copy link
Contributor

Any chance we could get that merge conflict fixed up?

@jonathanstowe
Copy link
Contributor

Looks good, I'd say all things being equal that we merge it and see where we stand after that.

@AlexDaniel
Copy link
Member

Speaking of something else, I think that it's time to merge this. :)

Nobody opposed really, so if there are some good reasons not to do that I guess that we will hear them after the merge.

@AlexDaniel AlexDaniel merged commit 92faf2e into master Jul 26, 2016
@zoffixznet zoffixznet deleted the wiki-entries-cleanup branch July 26, 2016 23:50
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants