add comments

Author: lukaszsamson

apps/language_server/lib/language_server/dialyzer.ex

@@ -491,6 +491,8 @@ defmodule ElixirLS.LanguageServer.Dialyzer do
 
   defp in_project?(path, project_dir) do
     # TODO return false for deps Mix.Project.config()[:deps_path]
+    # project_dir is absolute path with universal separators
+    # Path.absname result likewise
     File.exists?(path) and SourceFile.Path.path_in_dir?(Path.absname(path), project_dir)
   end
 

apps/language_server/lib/language_server/providers/formatting.ex

@@ -7,7 +7,7 @@ defmodule ElixirLS.LanguageServer.Providers.Formatting do
   def format(%SourceFile{} = source_file, uri = "file:" <> _, project_dir)
       when is_binary(project_dir) do
     file_path = SourceFile.Path.absolute_from_uri(uri)
-
+    # file_path and project_dir are absolute paths with universal separators
     if SourceFile.Path.path_in_dir?(file_path, project_dir) do
       # file in project_dir we find formatter and options for file
       case SourceFile.formatter_for(uri, project_dir) do

apps/language_server/lib/language_server/source_file/path.ex

@@ -117,6 +117,7 @@ defmodule ElixirLS.LanguageServer.SourceFile.Path do
     :os.type()
   end
 
+  # This function expects absolute paths with universal separators
   def path_in_dir?(file, dir) do
     case String.starts_with?(file, dir) do
       true ->