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

Mentioning web address in a doc-string. #18

Open
amanabt opened this issue Sep 9, 2017 · 3 comments
Open

Mentioning web address in a doc-string. #18

amanabt opened this issue Sep 9, 2017 · 3 comments
Assignees
Labels

Comments

@amanabt
Copy link
Member

amanabt commented Sep 9, 2017

Commit Hash: 28729c3

Issue
There is one instance in the code in this commit in which the developer, while mentioning a long web address(enough to exceed the 80 character limit), has divided the web address into three different lines.
You can find that instance in line number 132 of the file DG_Maxwell/code/app/wave_equation.py.
It looks like this

    https://cocalc.com/projects/1b7f404c-87ba-40d0-816c-2eba17466aa8/files/
    PM_2_5/wave_equation/documents/wave_equation_report
    /A_matrix.pdf?session=default

The issue is that when you copy the link written like this and paste it in the address bar of your browser, the new lines, and the tab space are converted into spaces and most probably, this will lead you a non-existing web page, or far worse, it may lead you to a different web page.

Suggestion
I think that we should just ignore the 80 character limit when mentioning the web address in the doc-strings.

@mchandra
Copy link
Contributor

mchandra commented Sep 9, 2017

Convert the web address into a tiny url and put the tiny url.

@amanabt
Copy link
Member Author

amanabt commented Sep 9, 2017

@mchandra
I will add this in the documentation guidelines. I think that we can use Google URL shortener
https://goo.gl/
@Balavarun5 Do you agree?

@Balavarun5
Copy link
Contributor

Yes, It's a good idea

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

No branches or pull requests

3 participants