class Solargraph::Convention::Base

The base class for Conventions.

A Convention provides Environs that customize ApiMaps with additional pins and other information. Subclasses should implement the `local` and `global` methods as necessary.

Constants

EMPTY_ENVIRON

Public Instance Methods

global(yard_map) click to toggle source

The Environ for a YARD map. Subclasses can override this method.

@param yard_map [YardMap] @return [Environ]

# File lib/solargraph/convention/base.rb, line 28
def global yard_map
  EMPTY_ENVIRON
end
local(source_map) click to toggle source

The Environ for a source map. Subclasses can override this method.

@param source_map [SourceMap] @return [Environ]

# File lib/solargraph/convention/base.rb, line 19
def local source_map
  EMPTY_ENVIRON
end