README.rst, NEWS.rst, CONTRIB.rst, DEPRECATED.rst etc #1067
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
CONTRIBUTING is new, so not adding that here.
Automated using:
$ cat NEWS | python bullet_names.py > NEWS2 && mv NEWS2 NEWS.rst
where the script was a simple state-machine:
import sys
status = 0
for line in sys.stdin:
if status == 0:
if line.rstrip().endswith((" contributors:", " contributors since the beta:", " people:", " first timers:")):
status = 1
elif status == 1:
if line.strip():
status = 2
line = "- " + line
elif status == 2:
if not line.strip():
status = 0
else:
line = "- " + line
sys.stdout.write(line)
Note still have a warning present from rst-lint from Bio.sequtils vs Bio.SeqUtils, which is legitimate: $ rst-lint DEPRECATED INFO DEPRECATED:591 Duplicate implicit target name: bio.sequtils.
Automated using:
$ python retitle.py < NEWS.rst > NEWS2 && mv NEWS2 NEWS.rst
where this was a simple state-based script:
import sys
status = 0
for line in sys.stdin:
if status == 0:
if line.rstrip() == "===================================================================":
line = ""
# sys.stderr.write("Found break\n")
status = 1
elif status == 1:
assert not line.strip()
status = 2
# sys.stderr.write("Found blank line after break\n")
elif status == 2:
if line.strip():
# sys.stderr.write("Found title: " + line)
line += ("=" * len(line.strip())) + "\n"
status = 0
sys.stdout.write(line)
|
Note this does not introduce back-ticks everywhere, e.g. It has also made me even more aware that there is no clear ordering convention in the |
Codecov Report
@@ Coverage Diff @@
## master #1067 +/- ##
==========================================
- Coverage 80.68% 80.67% -0.02%
==========================================
Files 323 323
Lines 49853 49853
==========================================
- Hits 40224 40218 -6
- Misses 9629 9635 +6
Continue to review full report at Codecov.
|
|
Looks fine to me! |
|
Given no objections and one endorsement, applying now... |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Renames our legacy extension-less text files to use
*.rstand tweak their contents as needed to render nicely as reStructuredText which looks much nicer under GitHub etc.Creates symlinks in order to preserve the legacy filenames (although I'm not sure how important that is?).
See also http://mailman.open-bio.org/pipermail/biopython/2017-February/016083.html and http://mailman.open-bio.org/pipermail/biopython-dev/2017-February/021644.html
Pending an enhancement of
rst-lintfrom https://github.com/twolfson/restructuredtext-lint/ to allow it to ignore "info" level issues, I plan to add checking the markup to our TravisCI setup.