better docs

Author: klkvr

crates/compilers/src/compilers/restrictions.rs

@@ -5,7 +5,9 @@ use std::{
 
 use semver::VersionReq;
 
+/// Abstraction over set of restrictions for given [`crate::Compiler::Settings`].
 pub trait CompilerSettingsRestrictions: Copy + Debug + Sync + Send + Clone + Default {
+    /// Combines this restriction with another one. Returns `None` if restrictions are incompatible.
     fn merge(self, other: Self) -> Option<Self>;
 }
 

crates/compilers/src/compilers/solc/mod.rs

@@ -190,14 +190,15 @@ impl DerefMut for SolcSettings {
     }
 }
 
+/// Abstraction over min/max restrictions on some value.
 #[derive(Debug, Clone, Copy, Eq, Default, PartialEq)]
 pub struct Restriction<V> {
     pub min: Option<V>,
     pub max: Option<V>,
 }
 
-impl<V: PartialEq + Ord + Copy> Restriction<V> {
-    /// Returns true if the given version satisfies the restrictions
+impl<V: Ord + Copy> Restriction<V> {
+    /// Returns true if the given value satisfies the restrictions
     ///
     /// If given None, only returns true if no restrictions are set
     pub fn satisfies(&self, value: Option<V>) -> bool {
@@ -237,6 +238,7 @@ impl<V: PartialEq + Ord + Copy> Restriction<V> {
     }
 }
 
+/// Restrictions on settings for the solc compiler.
 #[derive(Debug, Clone, Copy, Default)]
 pub struct SolcRestrictions {
     pub evm_version: Restriction<EvmVersion>,

crates/compilers/src/resolver/mod.rs

@@ -695,6 +695,7 @@ impl<L: Language, D: ParsedSource<Language = L>> Graph<D> {
         Err(msg)
     }
 
+    /// Filters profiles incompatible with the given node and its imports.
     fn retain_compatible_profiles<C: Compiler, T: ArtifactOutput>(
         &self,
         idx: usize,
@@ -730,7 +731,7 @@ impl<L: Language, D: ParsedSource<Language = L>> Graph<D> {
         if all_profiles.is_empty() {
             let f = utils::source_name(&failed_node.path, &self.root).display();
             return Err(
-                format!("Missing profile satisfying settings restrictions for {f}").to_string(),
+                format!("Missing profile satisfying settings restrictions for {f}").to_string()
             );
         }