search

mediawiki-client-tools / mediawiki-dump-generator

Python 3 tools for downloading and preserving wikis
https://github.com/mediawiki-client-tools/mediawiki-scraper
GNU General Public License v3.0
89 stars 14 forks source link

Update README.md #109

Closed robkam closed 1 year ago

robkam commented 1 year ago

Bring README.md up to date. The prepare-for-publication branch is deprecated.
The folder is called mediawiki-scraper but pip still installs wikiteam3. Got rid of unnecessary ` marks.

yzqzss commented 1 year ago

Why remove the ` code mark?

robkam commented 1 year ago

They were all over the document, unnecessarily. I've put all the commands now inside '''bash and '''.

robkam commented 1 year ago

The current readme is now out of date for anyone new to the package.

elsiehupp commented 1 year ago

Do you know of any style guides that talk about the use of tick marks? I personally know that I tend to err on the side of using them excessively (and I was the one who added them to the README in the first place), but if you can find an established style guide with coherent recommendations, I'd be willing to go with whatever it says.

(Regarding finding style guides: I know Red Hat has some, as do Google and GitHub itself.)

robkam commented 1 year ago

renamed it not deleted

elsiehupp commented 1 year ago

renamed it not deleted

Yes, renaming a branch that is the basis of a pull request breaks that pull request. (I've run into this issue myself.)

I was going to say: since you'll probably be opening a new pull request regardless, could you do things a little more piecemeal? Like the pull request could just remove the references to the deprecated prepare-for-publication branch, and then we could go from there.

robkam commented 1 year ago

I can only find that Red Hat, Google or GitHub say how to use inline code.

The Arctic Ice Studio Markdown Code Style's Use Cases gives a few examples of when and when not to use inline code.

Most of what I've found uses inline code blocks on almost every keyword and so on. Not always consistently, e.g. at at Google's Shell Style Guide in heading Test, [ … ], and [[ … ]] with, but in heading Eval and heading STDOUT vs STDERR without.

Conclusion, most of the backticks should stay as they are.