Improve docs & tests. Upgrade package version.

CXuesong · Aug 30, 2018 · 2afd905 · 2afd905
1 parent eaeb772
commit 2afd905
Show file tree

Hide file tree

Showing 3 changed files with 15 additions and 5 deletions.
diff --git a/UnitTestProject1/Tests/SiteTests.cs b/UnitTestProject1/Tests/SiteTests.cs
@@ -49,6 +49,7 @@ public async Task TestWpTest2()
             Assert.Equal("Wikipedia", site.SiteInfo.SiteName);
             Assert.Equal("Main Page", site.SiteInfo.MainPage);
             Assert.Equal("https://test2.wikipedia.org/wiki/test%20page", site.SiteInfo.MakeArticleUrl("test page"));
+            Assert.Equal("https://test2.wikipedia.org/wiki/test%20page%20(DAB)", site.SiteInfo.MakeArticleUrl("test page (DAB)"));
             var messages = await site.GetMessagesAsync(new[] {"august"});
             Assert.Equal("August", messages["august"]);
             ValidateNamespaces(site);

diff --git a/WikiClientLibrary/Sites/SiteInfo.cs b/WikiClientLibrary/Sites/SiteInfo.cs
@@ -75,7 +75,11 @@ public class SiteInfo
         /// </summary>
         /// <param name="title">The title of the article.</param>
         /// <exception cref="ArgumentNullException"><paramref name="title"/> is <c>null</c>.</exception>
-        /// <remarks>This overload uses <c>https:</c> as default protocol for protocol-relative.</remarks>
+        /// <remarks>
+        /// This overload uses <c>https:</c> as default protocol for protocol-relative URL.
+        /// For wiki sites with specified-protocol <see cref="ServerUrl"/>, such as Wikia (which uses http),
+        /// this overload respects the server-chosen protocol.
+        /// </remarks>
         public string MakeArticleUrl(string title)
         {
             return MakeArticleUrl(title, "https");
@@ -85,10 +89,15 @@ public string MakeArticleUrl(string title)
         /// Makes the full URL to the page of specified title.
         /// </summary>
         /// <param name="title">The title of the article.</param>
-        /// <param name="defaultProtocol">For protocol-relative URL (e.g. <c>//en.wikipedia.org/</c>),
+        /// <param name="defaultProtocol">
+        /// For wiki sites whose <see cref="ServerUrl"/> is protocol-relative URL (e.g. <c>//en.wikipedia.org/</c>),
         /// specifies the default protocol to use. (e.g. <c>https</c>)</param>
         /// <exception cref="ArgumentNullException">Either <paramref name="title"/> or <paramref name="defaultProtocol"/> is <c>null</c>.</exception>
         /// <returns>The full URL of the article.</returns>
+        /// <remarks>
+        /// For wiki sites with specified-protocol <see cref="ServerUrl"/>, such as Wikia (which uses http),
+        /// this overload respects the server-chosen protocol.
+        /// </remarks>
         public string MakeArticleUrl(string title, string defaultProtocol)
         {
             if (title == null) throw new ArgumentNullException(nameof(title));

diff --git a/WikiClientLibrary/WikiClientLibrary.csproj b/WikiClientLibrary/WikiClientLibrary.csproj
@@ -4,9 +4,9 @@
     <TargetFrameworks>netstandard1.1;netstandard2.0</TargetFrameworks>
     <AssemblyName>WikiClientLibrary</AssemblyName>
     <PackageId>CXuesong.MW.WikiClientLibrary</PackageId>
-    <Version>0.6.3</Version>
-    <AssemblyVersion>0.6.3.0</AssemblyVersion>
-    <FileVersion>0.6.3.0</FileVersion>
+    <Version>0.6.4</Version>
+    <AssemblyVersion>0.6.4.0</AssemblyVersion>
+    <FileVersion>0.6.4.0</FileVersion>
     <Copyright>Copyright (C) CXuesong 2018</Copyright>
     <Description>
       Wiki Client Library is a .NET Standard &amp; asynchronous client library for MediaWiki sites.