Skip to content

Commit

Permalink
XML doc tweak for SkolemFunctionIdentifier
Browse files Browse the repository at this point in the history
  • Loading branch information
sdcondon committed Aug 12, 2023
1 parent 89b2903 commit 1a57890
Showing 1 changed file with 8 additions and 10 deletions.
18 changes: 8 additions & 10 deletions src/SCFirstOrderLogic/SkolemFunctionIdentifier.cs
Original file line number Diff line number Diff line change
Expand Up @@ -5,20 +5,18 @@
namespace SCFirstOrderLogic
{
/// <summary>
/// Class for Skolem function identifiers, which are generated by the sentence normalisation process and feature in sentences in conjunctive normal form (CNF).
/// </summary>
/// <remarks>
/// <para>
/// NB #1: Doesn't override equality or hash code, so uses reference equality;
/// and the normalisation process creates exactly one instance per variable scope - thus achieving standardisation
/// without having to muck about with anything like trying to ensure names that are unique strings
/// (which only sentence formatting logic, not the identifier itself, should care about).
/// Class for Skolem function identifiers, which are generated by the sentence normalisation process and feature in sentences in conjunctive normal form (CNF).
/// </para>
/// <para>
/// NB #2: As with standardised variables, OPTIONAL value semantics for equality might be useful.
/// An equality comparer for this may appear in a future version.
/// The important thing about this class is that it doesn't override equality or hash code, so uses reference equality.
/// The normalisation process creates exactly one instance per variable scope - thus achieving standardisation
/// without having to muck about with anything like trying to ensure names that are unique strings (which only sentence
/// formatting logic, not the identifier itself, should care about).
/// </para>
/// </remarks>
/// </summary>
// As with standardised variables, optional value semantics for equality might be useful.
// An equality comparer for this may appear in a future version.
public class SkolemFunctionIdentifier
{
/// <remarks>
Expand Down

0 comments on commit 1a57890

Please sign in to comment.