codetriage / docs_doctor Goto Github PK

I signed up right after RubyConf to get documentation emails from three projects but I have never received any emails. Today I tried the 'Send more docs now' button and it responds with an application error.

Let me know if there's anything I can do to help debug this.

http://www.docsdoctor.org/users/182

I get a 500 on both actions.

When logged in, my home page (http://www.docsdoctor.org/) shows lists of "Repos you are currently helping" and "Repos needing the most help" where the name of each project is a link to the page for that project on DocsDoctor. However the link is escaping the slash in the path, so that the link for the rails/rails project is http://www.docsdoctor.org/rails%2Frails. This URL 404s with the message "The page you were looking for doesn't exist."

(first reported on the twitters)

ActiveRecord::Reflection::AggregateReflection#mapping shows in the user's inbox as docs to read about but the comment read :nodoc:

I propose blacklisting specific text from comments & then using the black list as a filter for comments to be suggested for reading & writing. This could look something like:

class DocComment < ActiveRecord::Base
...
validates :comment, exclusion: BLACKLIST
....
BLACKLIST = [ ":nodoc:", "documentation needed", "needs documentation", "todo"]

Today I received a notification about a method that comes from Ruby's ./sample directory.

AFAIK this directory is purposefully left out of .document, so it's not included in the documentation of Ruby; and as such should not be included in docs_doctor.

I don't think docs_doctor, codetriage are in the list of emails we can get right?
Also I was hoping to have docs_doctor for saltstack, like I have for codetriage, but the repositories' lists are not the same. Is it hard to add new repos?

I signed up for this recently to read docs, but haven't received a single email since I did so. I've tried requesting docs a few times, but I still haven't had anything show up.

I tried to delete my account (I think the project idea is great but I'm trying to cut down on the number of emails I'm receiving 😕 ) but get the "We're sorry, but something went wrong" error page when I click the delete button on my account.

I was hoping to sort it out myself and open a PR but I wasn't able to reproduce the error locally. Everything seemed to work fine locally.

I'd be happy to help out and try to fix the bug if I can but I need a little more info. Are you able to see what the error is in the production logs?

Example:
http://www.docsdoctor.org/doc_methods/25285
the Source link points to
https://github.com/ruby/ruby/blob/master/ext/json/lib/json/add/regexp.rb/#L11
which returns 404
It would appear that the ruby project doesn't have a 'master' branch, but instead they have 'trunk'
so a link like this would work
https://github.com/ruby/ruby/blob/trunk/ext/json/lib/json/add/regexp.rb/#L11
This 404 result seemed consistent for all of the ruby methods I looked at (which would make sense)

Within docs_doctor, it looks like this code is responsible for building the link https://github.com/codetriage/docs_doctor/blob/master/app/models/github_url_from_base_path_line.rb

 # https://github.com/rails/rails/blob/master/actionmailer/lib/action_mailer/collector.rb#L10
  def to_github
    File.join(@base, "blob/master", @path, "#L#{@line}")
  end

I don't know the best way to resolve this, but perhaps something where you can specify the 'branch' url section to use for the repo. ("blob/master" would be the default, but 'blob/trunk' would be specified for the ruby repo.

Thought maybe this was a mobile / safari thing but it looks like this is happening on chrome (desktop) too.

1. Visit http://www.docsdoctor.org/refinery/refinerycms
2. Click green "I want to read" button
3. 💥

http://www.docsdoctor.org/doc_methods/259451 links to an old commit, and the wrong line: (https://github.com/rails/rails/blob/9671df3ff797347940da2e813d005a4584ef464e/actionpack/lib/action_dispatch/request/session.rb/#L175)

On both that commit and master, the method concerned (load_for_write!) is private.

Presumably private methods are not intended to be documented?

I was just paging through the docs for rails, and it took me an embarrassingly long time before I realized that the docs there were for every method, not just the undocumented ones. And yes, I saw the
"(undocumented)" string next to the method title, but I was confused.

My use case was coming to manually find undocumented methods, because the one I received via email today stumped me. A way to filter between documented and undocumented methods would be awesome.

I tried accessing docsdoctor.org from my iPhone and the page is unusable. The heading part shows up but then the language selection is so far to the left that it's off the screen. And most of the other elements are at weird spots half on/half off the screen.

I think it's because you're using a container as the base div. Have you considered just using offsets instead of a container to get the centered effect you want?

Hi,

My user edit action isn't working. It's returning the generic 'We're sorry something went wrong" heroku page. I'd be happy to look at the issue myself and try to fix it.

Jeremy

When I'm logged in to the DocsDoctor.org site, and I click on my username (the link between Home and Sign Out at the top of the page), the following error message is displayed:

We're sorry, but something went wrong.

If you are the application owner check the logs for more information.

I don't even. 😄

http://www.docsdoctor.org/doc_methods/289768, the method in question is in a class labelled like this:

class Scanner # :nodoc:

I don't know if that's valid.

Instead of X docs per day I would like to reduce the frequency of the mails to one mail every 3 days or once a week. (else I would ignore them most times)

Moved from #39 (comment) to new issue.

As a visitor
If I go to http://docsdoctor.org
I am presented with Heroku's "No such app"

As a visitor
If I go to http://www.docsdoctor.org
I am presented with the website I expected

Unfortunately, both of these pass right now 😉

http://www.docsdoctor.org/doc_methods/83635 is about docs for ActiveRecord::LogSubscriber#odd?

There is no odd? method in ActiveRecord::LogSubscriber - either on the old commit which the link points to (https://github.com/rails/rails/blob/1add44d5dc6e14e63eade32391d1d5395c3bc865/activerecord/lib/active_record/log_subscriber.rb/#L65) Or on master (https://github.com/rails/rails/blob/master/activerecord/lib/active_record/log_subscriber.rb)