lucenenet-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From GitBox <...@apache.org>
Subject [GitHub] [lucenenet] NightOwl888 commented on issue #229: Updates docs build
Date Tue, 20 Aug 2019 01:26:48 GMT
NightOwl888 commented on issue #229: Updates docs build
URL: https://github.com/apache/lucenenet/pull/229#issuecomment-522814770
 
 
   Alright. Just a heads up I have made lots of changes to the docs in test framework (but
nowhere else). So be sure to skip that module. I am trying to get to a point where I can merge
it so we can sync up.
   
   Some of the issues with the warnings are due to the fact some types don't exist in .NET
Standard 1.6.
   
   I found a workaround that we might be able to use for `ConcurrentMergeScheduler`. In the
test framework, some of the docs refer to NUnit-specific types, such as `AssertionException`,
so I did this:
   
   ```
   // LUCENENET NOTE: These are primarily here because they are referred to
   // in the XML documentation. Be sure to add a new option if a new test framework
   // is being supported.
   #if TESTFRAMEWORK_MSTEST
   using AssumptionViolatedException = // Whatever the type is in MSTest
   #elif TESTFRAMEWORK_XUNIT
   using AssumptionViolatedException = // Whatever the type is in xUnit
   #else // #elif TESTFRAMEWORK_NUNIT
   using AssumptionViolatedException = NUnit.Framework.InconclusiveException;
   #endif
   ```
   
   Unfortunately, that will only work for classes. Some of the warnings are due to methods
that don't exist in .NET Standard 1.6 and I am not sure what to do in that case. It may be
that duplicating the entire documentation that refers to the methods may be the only choice.

----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
 
For queries about this service, please contact Infrastructure at:
users@infra.apache.org


With regards,
Apache Git Services

Mime
View raw message