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

Broken links in docstrings / readthedocs, slightly urgent #91

Closed
jstac opened this issue Nov 3, 2014 · 5 comments
Closed

Broken links in docstrings / readthedocs, slightly urgent #91

jstac opened this issue Nov 3, 2014 · 5 comments

Comments

@jstac
Copy link
Contributor

jstac commented Nov 3, 2014

A lot of links in the docstrings, and hence readthedocs, have been broken by the code reorganization. For example, the link

http://quant-econ.net/kalman.html

in

http://quanteconpy.readthedocs.org/en/latest/tools/kalman.html

@sglyon
Copy link
Member

sglyon commented Jan 28, 2015

I noticed we took most of these links out of the source files.

Now that urls have settled down, do we want to add them back in?

@jstac
Copy link
Contributor Author

jstac commented Jan 28, 2015

Right, I forgot about this. It would be great to have the links fixed. Many are still broken. Eg.,

https://github.com/QuantEcon/QuantEcon.py/blob/master/quantecon/kalman.py

The links could go in the docstrings or in the display attributes for print, etc.

mmcky added a commit that referenced this issue Aug 4, 2015
@mmcky
Copy link
Contributor

mmcky commented Aug 4, 2015

Just went through grep and fixed the links without py and ones that have had names changes. Do we need to add other reference links as per @spencerlyon2 comment?

@jstac
Copy link
Contributor Author

jstac commented Aug 5, 2015

@mmcky Could you please clarify? It sounds like you've already dealt with the issues mentioned by @spencerlyon2

@mmcky
Copy link
Contributor

mmcky commented Aug 5, 2015

@jstac I have fixed a few links that are currently contained within the docstrings by checking all grep matches of html:// and reviewing them. I read @spencerlyon2's comment to suggest that in the past some of the reference links were deleted from the docstrings and that some may need to be reinstated?

mmcky added a commit that referenced this issue Aug 7, 2015
@mmcky mmcky closed this as completed Aug 7, 2015
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

No branches or pull requests

3 participants