question-mark
Stuck on an issue?

Lightrun Answers was designed to reduce the constant googling that comes with debugging 3rd party libraries. It collects links to all the places you might be looking at while hunting down a tough bug.

And, if you’re still stuck at the end, we’re happy to hop on a call to see how we can help out.

Docs - convert java snippets to c#

See original GitHub issue

Requires: https://github.com/apache/lucenenet/issues/283

Once we have an idea about how this works https://github.com/apache/lucenenet/issues/283 we can start the snippet conversion. This could be broken down into smaller tasks and listed as up for grabs.

~15 hrs


This issue no longer depends on #283, since that issue was addressed by #396. So this issue is no longer blocked.

Here is a list of all of the documentation files that will require a review to update code examples. Note that links are a different issue that is being worked on in #300. So in this issue, we should focus on:

  1. Updating Java code examples to C#. Make sure the examples will compile the way they are written after the conversion.
  2. Updating references to Java technologies (types, JVM, class path, etc) to their .NET equivalents. Some of this will require some research. Note that some things like links over to Java-related wikipedia articles are probably best to leave alone and other things like types that exist in Java but don’t in .NET and are still required to make the flow of the docs work might need to be clarified for the average .NET developer.
  3. Make sure the formatting of the Markdown document is similar to how it was in Lucene - that is, make sure the numbered and unordered lists come up correctly, tables are legible, etc.
  4. Look out for issues with API usability and open issues about them if any are found.

NOTE: The main documents to focus on here are named overview.md and package.md. The rest could probably just use a cursory review.

Issue Analytics

  • State:closed
  • Created 3 years ago
  • Comments:8 (6 by maintainers)

github_iconTop GitHub Comments

2reactions
NightOwl888commented, Aug 2, 2020

Sorry, I mean the Java Lucene version. I am seeing that the latest Java Lucene is 8.6.0. Does Lucene.Net 4.8.0 match Lucene 4.8.0?

The core Lucene.Net project is based on 4.8.0. Most of the submodules including Lucene.Net.Analysis.Common are based on 4.8.1. Some of the other analysis modules were ported from 7.2.0 and 8.2.0 (which were the latest at the time we ported them).

I am asking because I cannot believe it falls behind so much.

That is the battle we are fighting. People get the impression that we are far behind because of the number of years it has taken and the fact there are 4 major versions between Lucene.NET and Lucene.

Last I checked (I believe it was 8.3.0), there were exactly 7 new modules and about 12 new features of any consequence added since 4.8.0. That’s it. Look at the source code if you don’t believe it. There was a discussion back in 2018 that I wasn’t part of where some people said they are withholding their support because we are not targeting the latest version. I am curious to know whether they realize:

  • Lucene.NET 4.8.0 is almost stable and has been since that conversation happened in 2018
  • We have been working on Lucene.NET’s dependencies since then (that both 4.8.0 and 8.x require)
  • It would take around 1800 hours to upgrade from 4.8.0 to 8.x, not including the 1100-1200 hours we have yet to complete now
  • Changing gears now will rob the .NET community of a stable Lucene.NET 4.8.0 in 2021, and take at least an extra year to stabilize and roll out
  • We are planning to upgrade to 8.x after the release of Lucene.NET 4.8.0 is stable and we have secured enough funding to get started
  • 8.x has only about 12 new features that 4.8.0 doesn’t have that are of any consequence

I am also curious to know which of the 12 or so new features that people think are so important that they are withholding their support, and how they could ever think it would be worth it for us to derail the whole project for at least a year to try to reach that goal. Not to mention robbing the entire .NET community of a stable 4.8.0 while they wait for that work to be completed.

Our sponsors at Microsoft don’t agree with those people. They don’t even agree with us that it is worth it to upgrade to 8.x after the release of 4.8.0. Sure there are bug fixes and performance benefits in the new version, but the total benefit for the cost just isn’t there.

Unfortunately the gap between the reality of the situation and the impression that people get about how far we are behind is a big one, and that situation isn’t going to change until we either reach a stable 4.8.0 or the community provides enough funding for the extra 1800 hours of labor involved in re-targeting to 8.x.

0reactions
NightOwl888commented, Mar 25, 2021

@Shazwazza

I have generated a list of the Markdown documents and tailored it to the API docs that we should review for this issue.

However, in the process I noticed that we have demo examples that have been copied into the docs:

I don’t know specifically how often we are going to need to update the demos, but having duplicate copies of them doesn’t seem like a good idea maintenance-wise. And if we are going to copy them, we are missing the 2 main ones that are linked from the main “core” overview page:

Is there some reason why we need to duplicate this code into documents? Ideally, our docs would link to the state of these files at the tag of the release so we wouldn’t have extra documents to maintain when the code changes.

Also, where are these documents linked from on the website? I couldn’t find any references to them.

Read more comments on GitHub >

github_iconTop Results From Across the Web

How to convert Java code snippet into C# - Stack Overflow
I'm struggling to understand how to convert this Java code into a C# one. Any help is greatly appreciated. public enum Direction {...
Read more >
Easily format and display code in Google Docs
End users: To format and display code in a Doc, select Insert > Building blocks > Code blocks > choose your programming language...
Read more >
Snippets in Visual Studio Code
Snippets in Visual Studio Code. Code snippets are templates that make it easier to enter repeating code patterns, such as loops or conditional-statements....
Read more >
Paste and Convert Code Snippets with Oxidizer - Elements Docs
Paste and Convert Code Snippets with Oxidizer ... Simply copy a piece of C#, Objective-C, Java, Swift or Delphi code from an existing...
Read more >
2 Snippets - Java
JShell accepts Java statements; variable, method, and class definitions; imports; and expressions. These pieces of Java code are referred to as snippets.
Read more >

github_iconTop Related Medium Post

No results found

github_iconTop Related StackOverflow Question

No results found

github_iconTroubleshoot Live Code

Lightrun enables developers to add logs, metrics and snapshots to live code - no restarts or redeploys required.
Start Free

github_iconTop Related Reddit Thread

No results found

github_iconTop Related Hackernoon Post

No results found

github_iconTop Related Tweet

No results found

github_iconTop Related Dev.to Post

No results found

github_iconTop Related Hashnode Post

No results found