Skip to content

Fixing markup on reStructuredText documents - #105

Merged
rptb1 merged 5 commits into
masterfrom
branch/2023-01-10/github-fix-readme
Feb 1, 2023
Merged

Fixing markup on reStructuredText documents#105
rptb1 merged 5 commits into
masterfrom
branch/2023-01-10/github-fix-readme

Conversation

@rptb1

@rptb1 rptb1 commented Jan 11, 2023

Copy link
Copy Markdown
Member

I suggest reviewing this by (inter alia) looking at how the changed documents appear on GitHub, since that's the purpose of the work.

Fixes #99 .

Prevented by #112 .

@rptb1
rptb1 requested review from UNAA008 and thejayps January 11, 2023 01:14
@rptb1
rptb1 marked this pull request as ready for review January 11, 2023 01:18
@rptb1 rptb1 linked an issue Jan 11, 2023 that may be closed by this pull request
@rptb1 rptb1 added git-migration Project migration from Ravenbrook internal Perforce infrastructure to public git repo optional Will cause failures / of benefit. Worth assigning resources. labels Jan 14, 2023

@rptb1 rptb1 left a comment

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

  1. Im: GitHub does not recognize licence.
  2. Im: Build instructions have some Sphinx markup (:ref: :term:) that GitHub can't interpret.
  3. Im: Supported platforms might be easier to read as a table.

@UNAA008 UNAA008 left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should the change history of these documents be updated?

@rptb1

rptb1 commented Feb 1, 2023

Copy link
Copy Markdown
Member Author

Executing draft express review procedure.

  1. I've called in @UNAA008
  2. @UNAA008 and @rptb1 agree the change is low risk.
  3. Improvement suggestion: purpose should include getting stuff done
  4. We agree none of the issue should prevent exit.
  5. One minute brainstorm: Clarify what explicit document history is for. Quick low risk edits can even be done via GitHub web editor, like 1ddf11a.
  6. Failed exit because we haven't taken action on our own issue. Let's do that.
  • Im: GitHub does not recognize licence.

Already captured at #98 (comment)

  • Im: Build instructions have some Sphinx markup (:ref: :term:) that GitHub can't interpret.

Forget: Not worth worrying about.

  • Im: Supported platforms might be easier to read as a table.

Edit: 1ddf11a

Should the change history of these documents be updated?

Raise: #140

  1. Exit criteria passed this time.
  2. Revised change passed!
  3. First test of express review done.
  4. review.exit.calc
  • elapsed time: 35 mins
  • hours used: 1h
  • hour saved: unclear but non-zero

@UNAA008 UNAA008 left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Approving merge as a result of this review #105 (comment)

@rptb1
rptb1 merged commit 40f2312 into master Feb 1, 2023
@rptb1

rptb1 commented Feb 1, 2023

Copy link
Copy Markdown
Member Author

Executing proc.merge.pull-request

  1. There is not really an automated test case because it would need to view documents via the GitHub web interface and assess how readable they were. You potentially could check whether *.rst is in a particular format using e.g. curl but maybe we can add a rule to Check the syntax of reStructuredText files during CI #112 to make sure it works anyway.
  2. There's a conflict in .travis.yml but it's trivial and I'll deal with it in merge.

Merge completed in 25 mins.

jollaitbot pushed a commit to sailfishos-mirror/emacs that referenced this pull request Sep 17, 2025
jollaitbot pushed a commit to sailfishos-mirror/emacs that referenced this pull request Sep 17, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

git-migration Project migration from Ravenbrook internal Perforce infrastructure to public git repo optional Will cause failures / of benefit. Worth assigning resources.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

reStructuredText documents are not shown correctly by GitHub

2 participants