Warehouse: Comment out projects statistics tab

Created on 30 Jun 2016  ·  9Comments  ·  Source: pypa/warehouse

For launch it is unrealistic that this will be complete.
We should comment out this tab and implement this feature later.

HTML good first issue

Most helpful comment

Note - please use Jinja2 comments rather than HTML comments for this issue.

All 9 comments

Imho commenting out code is bad practice when you have a VCS like git. What are the community's opinions on this? If you just cut it out, it will still be there in the history... so why leave commented-out code? I don't really feel that it's more convenient than looking back in history with Git, it just adds clutter. What's the rationale for commenting?

@controversial I hear what you're saying, but:

  1. when the thing being commented out is a small specific piece of functionality (as opposed to, like, a framework being called in a bunch of different places)
  2. that we are going to come back to in a few months
  3. and not that many people are working on the software, and everyone involved knows the history

I'm fine with commenting it out. And if we delete it instead of commenting it out, I'm in favor of leaving a comment mentioning the gitlog hash of the last commit with the relevant code in it & mentioning any relevant issue number.

[My git journey has not yet gotten to the place where I'm comfortable searching a git history for deleted code/files with grep or log or bisect -- maybe that's next.]

Ok. Makes sense 👍 I hope to start contributing in some minor way at some
point soon, maybe later today.

On Sat, Jul 2, 2016 at 10:04 AM Sumana Harihareswara <
[email protected]> wrote:

@controversial https://github.com/controversial I hear what you're
saying, but:

  1. when the thing being commented out is a small specific piece of
    functionality (as opposed to, like, a framework being called in a bunch of
    different places)
  2. that we are going to come back to in a few months
  3. and not that many people are working on the software, and everyone
    involved knows the history

I'm fine with commenting it out. And if we delete it instead of commenting
it out, I'm in favor of leaving a comment mentioning the gitlog hash of the
last commit with the relevant code in it & mentioning any relevant issue
number.

[My git journey has not yet gotten to the place where I'm comfortable
searching a git history for deleted code/files with grep or log or bisect
-- maybe that's next.]


You are receiving this because you were mentioned.
Reply to this email directly, view it on GitHub
https://github.com/pypa/warehouse/issues/1310#issuecomment-230103184,
or mute the thread
https://github.com/notifications/unsubscribe/AJ5YrydBDYTpNLW6NQ6nTF64iuzhVRP4ks5qRm_ggaJpZM4JB1br
.

@controversial Thanks! We often hang out in Freenode IRC, in the #pypa-dev channel, although I can't guarantee anyone will be there at any particular moment. And you've probably already seen the Great for new contributors label...

Right. All of those seem to be on the first page 😛 Any reason why the
community isn't on Slack? I'm on an iOS device a lot and I don't really
have an IRC setup going

On Sat, Jul 2, 2016 at 10:11 AM Sumana Harihareswara <
[email protected]> wrote:

@controversial https://github.com/controversial Thanks! We often hang
out in Freenode IRC, in the #pypa-dev channel, although I can't guarantee
anyone will be there at any particular moment. And you've probably already
seen the Great for new contributors
https://github.com/pypa/warehouse/labels/Great%20for%20new%20contributors
label...


You are receiving this because you were mentioned.
Reply to this email directly, view it on GitHub
https://github.com/pypa/warehouse/issues/1310#issuecomment-230103598,
or mute the thread
https://github.com/notifications/unsubscribe/AJ5Yr5gqMCbSm4urneLXAz8nrJMsuDXxks5qRnGWgaJpZM4JB1br
.

Any reason why the community isn't on Slack?

Mostly because it's a community that predates Slack existing :)

Ok 🙃 A slack team probably wouldn't be unwise…
On Sat, Jul 2, 2016 at 1:08 PM Donald Stufft [email protected]
wrote:

Any reason why the community isn't on Slack?

Mostly because it's a community that predates Slack existing :)


You are receiving this because you were mentioned.
Reply to this email directly, view it on GitHub
https://github.com/pypa/warehouse/issues/1310#issuecomment-230112072,
or mute the thread
https://github.com/notifications/unsubscribe/AJ5Yr8rqqaGQ0iitmIgBCwvDYAZSuBxeks5qRpsegaJpZM4JB1br
.

Note - please use Jinja2 comments rather than HTML comments for this issue.

I agree with @controversial on the comments. In most cases, I like to take a "use it or lose it" approach, otherwise you end up with files that are half commented out because someone's afraid of losing something.

I think this is a special case since we're going to be putting this code back in shortly. And hooray for Slack!

Was this page helpful?
0 / 5 - 0 ratings

Related issues

webknjaz picture webknjaz  ·  4Comments

ewjoachim picture ewjoachim  ·  3Comments

mbakke picture mbakke  ·  3Comments

zt2 picture zt2  ·  4Comments

mahmoud picture mahmoud  ·  4Comments