11

Existing rules These are covered in multiple questions Question body: Should a post with no specific question(s) imply a general review? Should [programming-challenge] questions require a summary of the challenge? Reviewing design: Should design questions be on-topic here? Reviewing "design" If there is little/no code: Can I ask a question ...


9

It somewhat pains me to do this, but as it stands, the question needs to be rolled back. So that's also what I did. As MartinR observed in the comments to your inquiry here, answers to off-topic questions do not trigger answer-invalidation concerns. But since the question was on-topic when you answered it, this is a case of invalidation and needs to be ...


9

I see 2 questions: Is Jupyter reviewable? Is linkrot a dealbreaker? 1) Yes. 2) Yes. Jupyter is basically annotated Python. A global script cut in pieces. The link can stay as additional context, but anything not embedded in the question itself is not reviewable. With a Jupyter notebook, this means essential parts of the code are missing in the question ...


8

If there were a mechanism (?) to impose an edit freeze while discussion happens, I'd vote for that, but I don't know that there is one. Actually... there is a mechanism for that. It's just not available to regular users. For cases where edits keep getting applied back and forth, diamond moderators have the ability to lock a post. Before this happens it can ...


8

The banner you are seeing contains an explanation. You also got a comment from one of the users involved in closing your question that explicitly asks you to "elaborate what the instructions are to accomplish". To phrase that in a little less complicated English: We can see that you have some code. It seems to be doing what you want it to do. It's ...


7

For a question to be on-topic it must have a compiler, interpreter or travel through a series of transpilers until we get something we can run. For example JSX + TypeScript -> JavaScript is fine. Whilst the OP would more than happily post pseudocode, we won't allow it. Since it's not pseudocode we can happily forget about this rule, as thinking about it ...


7

Note, your question in this meta post is about why asking about best-practices in general are off topic, and you provide some example questions which were closed. Note, those questions were not (necessarily) closed because they were about best practices in general. The close reason covers a number of different possible reasons for the closure. The first ...


5

Getting it reviewed There are three ways an OP can get the code in the question. These are: Manually copy the code As shown in the linked question, manually copying some of the notebook over to a Code Review question is acceptable and can produce an ok question. Save the history as a plain old Python file A Jupyter notebook is just an IPython shell. The ...


5

We don't have the tools to help you with your request. If you want to keep the list updated, then creating a GitHub, SourceForge or BitBucket repository will be better equipped for that. Anyone with an account can create a PR and if you set the permissions up, you can get it so anyone can update the list without a PR. You also get additional features such ...


5

Users that are new to the network may not intuitively understand that they do not own any of the content they post on Stack Exchange, as per terms of service all user content is licensed under CC-BY-SA, and as content hosted on the SE network it is the duty of network users to make sure all network content looks great and reads well, and this is incentivized ...


4

Code that's not included can not be reviewed. That's simple. "I don't want to separate it into independent questions because the components altogether form the whole architecture; I think that the entire context is important here." Considering you've posted the general overview and context in your first question, that question can serve as extra ...


4

Your question isn't entirely clear, but I'll try to answer it since I suspect what you're really looking for is a combination of the following. Pseudocode is off-topic. There's multiple reasons for this, but one of them is that the code has to be actual code, from a project or anything, that's actually used or has been used. In this case, the code presented ...


3

The question is for questions, not for responding to answers. It's sufficiently simple and clear-cut that I have, as Wikipedia puts it, be[en] bold and rolled back to a version of the question which was pretty much just question. (I was tempted to roll back to version 1, but I thought that might be overdoing it). On the more general subject of how to ...


3

Should something be done about the "reasoning" part, that brings no value to the post? Should it be edited out? IMO voting is the way to go here. Editing out the reasoning part won't make the question any better. If I look at the question above the reasoning part I don't see a good question. It reads more like an answer to a question.


2

I think there are multiple levels of issues / reviews. Character level review. These are the 'petty' points such as style guide conformance and whitespace issues. You should have spaces on both sides of operators. Line level review. These are normally pretty basic changes and focus on how to improve the readability of a specific line. It's more Pythonic ...


Only top voted, non community-wiki answers of a minimum length are eligible