[
https://issues.apache.org/jira/browse/LUCENE-10270?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=17451700#comment-17451700
]
ASF subversion and git services commented on LUCENE-10270:
----------------------------------------------------------
Commit 4dc3e8ab0173bdb2a3d0b11367bc4aabc6e82867 in lucene's branch
refs/heads/main from Robert Muir
[ https://gitbox.apache.org/repos/asf?p=lucene.git;h=4dc3e8a ]
LUCENE-10270: Improve MIGRATE.md (#491)
* LUCENE-10270: Improve MIGRATE.md
* Separate sections for 9.0 and 9.1
* Remove abbreviations for artifact, package, class names etc. e.g.
`lucene-core` instead of `core` and `org.apache.lucene.analysis` instead of
`o.a.l.a`.
* Specify "java" for text blocks to get syntax highlighting
* When provided, consistently put JIRA issue in the same place
* Fixed-width font for classes/reserved words (e.g. false, true, long, makes
for less ambiguous reading)
* More use of tables vs lists when there is mapping of old -> new names
(packages, classes, etc)
* Use consistent notation for method calls (Class.method() vs Class.method vs
Class#method etc)
* LUCENE-10270: replace LUCENE_ with LUCENE- so it gets JIRA link
* LUCENE-10270: fix things found by msokolov
> Improve MIGRATE.md
> ------------------
>
> Key: LUCENE-10270
> URL: https://issues.apache.org/jira/browse/LUCENE-10270
> Project: Lucene - Core
> Issue Type: Task
> Reporter: Robert Muir
> Priority: Major
> Fix For: 9.1
>
> Time Spent: 40m
> Remaining Estimate: 0h
>
> When looking at MIGRATE.md, there are some easy improvements we can make for
> readability, searchability, presentation.
> Here's what I tried to tackle as an initial stab:
> 1. Separate sections for 9.0 and 9.1
> 2. Remove abbreviations for artifact, package, class names etc. e.g.
> `lucene-core` instead of `core` and `org.apache.lucene.analysis` instead of
> `o.a.l.a`.
> 3. Specify "java" for text blocks to get syntax highlighting
> 4. When provided, consistently put JIRA issue in the same place
> 5. fixed-width font for classes/reserved words (e.g. {{false}}, {{true}},
> {{long}}, makes for less ambiguous reading)
> 6. More use of tables vs lists when there is mapping of old -> new names
> (packages, classes, etc)
> 7. Use consistent notation for method calls (Class.method() vs Class.method
> vs Class#method etc)
--
This message was sent by Atlassian Jira
(v8.20.1#820001)
---------------------------------------------------------------------
To unsubscribe, e-mail: issues-unsubscr...@lucene.apache.org
For additional commands, e-mail: issues-h...@lucene.apache.org
