lucenenet-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From NightOwl888 <...@git.apache.org>
Subject [GitHub] lucenenet pull request #206: API Doc site generator using DocFx script
Date Fri, 30 Jun 2017 09:32:23 GMT
Github user NightOwl888 commented on a diff in the pull request:

    https://github.com/apache/lucenenet/pull/206#discussion_r124999920
  
    --- Diff: apidocs/api/index.md ---
    @@ -129,6 +128,9 @@ index for all the files contained in a directory.</li>
     &nbsp;<a href="../demo/src-html/org/apache/lucene/demo/SearchFiles.html">SearchFiles.java</a>
prompts for
     queries and searches an index.</li>
     </ul>
    +
    +<!-- TODO: Fix this  -->
    +
    --- End diff --
    
    I am working on making the CLI tools executable now. Unfortunately, there are many roadblocks
that need to be worked through. 
    
    - https://stackoverflow.com/questions/44829928/how-to-specify-default-entry-point-for-net-core-console-application-with-cspro
    - https://stackoverflow.com/questions/44830430/is-it-possible-to-make-the-same-dll-into-both-a-console-application-and-a-nuget
    - https://stackoverflow.com/questions/44835273/is-there-a-way-to-make-a-console-application-run-using-only-a-single-file-in-ne
    
    So as of this moment, I don't yet have a plan on how to divide up these tools, which will
affect what these commands look like in the docs.
    
    While sticking close to the way it works in Java has worked in the past, in .NET that
would mean making DLLs that work as console apps only and DLLs that work as NuGet reference
DLLs only. Sticking close to the original implementation would mean having 2 different DLLs
with the same name for different purposes (confusing). It seems like the best alternative
option will be to make a single wrapper console DLL (lucene.dll or perhaps lucenenet-tools.dll)
that references all of the existing .NET Standard DLLs, and then zipping it for download.
    
    Of course, whatever the solution, it would be advantageous to document the commands all
in one place (like [dotnet.exe](https://docs.microsoft.com/en-us/dotnet/core/tools/dotnet))
and having that one place linked to by the rest of the docs.


---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastructure@apache.org or file a JIRA ticket
with INFRA.
---

Mime
View raw message