Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Remaining Documentation Bugs #969

Open
1 task done
paulirwin opened this issue Oct 12, 2024 · 0 comments
Open
1 task done

Remaining Documentation Bugs #969

paulirwin opened this issue Oct 12, 2024 · 0 comments
Labels
docs Applies to the API docs or website good-first-issue Good for newcomers help-wanted Extra attention is needed is:bug up-for-grabs This issue is open to be worked on by anyone
Milestone

Comments

@paulirwin
Copy link
Contributor

paulirwin commented Oct 12, 2024

Is there an existing issue for this?

  • I have searched the existing issues

Describe the bug

After #911, it was discovered during testing that several documentation bugs remain. This item tracks those issues:

  1. The Performance Notes section here is not formatted correctly: /api/memory/Lucene.Net.Index.Memory.html#example-xquery-usage
  2. The "where" section formulas are not being formatted correctly on /api/core/Lucene.Net.Search.Similarities.TFIDFSimilarity.html. Do note that the formulas also look differently than they did in the Javadoc (it was also this way in prior releases). Ideally, we could find a way to make the formulas look right both in the API docs and Intellisense.
  3. In this block: http://localhost:8080/api/core/Lucene.Net.Analysis.html#attribute-and-attributesource, the table is missing the entire first column with the attributes and links. This seems like important info that is missing. It looks like several other tables are failing to resolve links, but this one is stripping them completely.
  4. It is difficult to remember where you have been on the API docs if the link visited text is the same as the unvisited text, which was a bit annoying when trying to visit all of the links for a test.
  5. Several unconverted xrefs on /api/analysis-opennlp/Lucene.Net.Analysis.OpenNlp.html without warnings during build

Expected Behavior

No response

Steps To Reproduce

No response

Exceptions (if any)

No response

Lucene.NET Version

No response

.NET Version

No response

Operating System

No response

Anything else?

No response

@paulirwin paulirwin added help-wanted Extra attention is needed docs Applies to the API docs or website good-first-issue Good for newcomers labels Oct 13, 2024
@paulirwin paulirwin added this to the 4.8.0 milestone Oct 25, 2024
@paulirwin paulirwin added the up-for-grabs This issue is open to be worked on by anyone label Oct 28, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs Applies to the API docs or website good-first-issue Good for newcomers help-wanted Extra attention is needed is:bug up-for-grabs This issue is open to be worked on by anyone
Projects
None yet
Development

No branches or pull requests

1 participant