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

Useless "Documentation for " in some page titles. #1623

Closed
rafaelschipiura opened this issue Oct 24, 2017 · 8 comments
Closed

Useless "Documentation for " in some page titles. #1623

rafaelschipiura opened this issue Oct 24, 2017 · 8 comments
Labels
good first issue If you want to dive in, this would be a good place to start

Comments

@rafaelschipiura
Copy link
Contributor

From splitting #1212

remove the "Documentation for " string that's prepended to the title of some pages (it seems useless; why was it added?) to make more room ;

@coke
Copy link
Collaborator

coke commented Oct 24, 2017

Can you provide an example of a page that contains this?

@rafaelschipiura
Copy link
Contributor Author

@AlexDaniel Can you provide examples?

@raiph
Copy link
Contributor

raiph commented Oct 25, 2017

Some (all?) of the routine pages, eg https://docs.perl6.org/routine/Date

@AlexDaniel
Copy link
Member

@AlexDaniel
Copy link
Member

@W4anD0eR96 I think it should be “Method Date” and not “method Date”. I guess a call to .tc won't hurt?

@AlexDaniel AlexDaniel reopened this Nov 4, 2017
@tisonkun
Copy link
Member

tisonkun commented Nov 4, 2017

@AlexDaniel , should it?

I will agree with that about "Method Date". it requires change "method" to "Method"

https://github.com/perl6/doc/blob/9659f324ebe600436a2ae098284d5e2da9861452/htmlify.p6#L929

However, "infix" should not be "Infix", I think.

https://github.com/perl6/doc/blob/9659f324ebe600436a2ae098284d5e2da9861452/htmlify.p6#L901

@tisonkun
Copy link
Member

tisonkun commented Nov 4, 2017

@AlexDaniel , now my opinion is opposite of yours.

  1. In /type/*, like https://docs.perl6.org/type/AST, we use method and class

  2. change code at line 929 will not convert all method to Method

For details, it works on https://docs.perl6.org/routine/(cont).%E2%88%8B.html,
but fails on https://docs.perl6.org/routine/old.

That's because the logic used to build there two sites are different. If we insist convert all method to Method(while keep infix asinfix), then we should test if $subkind eq 'method', that's quite dirty

@AlexDaniel
Copy link
Member

@W4anD0eR96 OK. Then let's keep it lowercase and if somebody else complains, we'll do something about it. Until then, this can be closed! :)

Thanks!

@coke coke added good first issue If you want to dive in, this would be a good place to start and removed LHF labels Apr 9, 2018
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
good first issue If you want to dive in, this would be a good place to start
Projects
None yet
Development

No branches or pull requests

5 participants