From 4340ce39b51014438a0aff4e69da53e6dd023ed9 Mon Sep 17 00:00:00 2001
From: Manuel Pitz <manuel.pitz@eonerc.rwth-aachen.de>
Date: Wed, 23 Mar 2022 10:02:22 +0100
Subject: [PATCH] Documentation update

---
 doc/openapi/components/schemas/config/format.yaml |  2 +-
 .../components/schemas/config/hook_obj.yaml       |  1 +
 .../components/schemas/config/hook_spec.yaml      |  1 +
 etc/examples/hooks/pmu_dft.conf                   | 15 +++++++--------
 lib/hooks/round.cpp                               |  2 +-
 5 files changed, 11 insertions(+), 10 deletions(-)

diff --git a/doc/openapi/components/schemas/config/format.yaml b/doc/openapi/components/schemas/config/format.yaml
index 3c5ff4d7d..d8b2948f6 100644
--- a/doc/openapi/components/schemas/config/format.yaml
+++ b/doc/openapi/components/schemas/config/format.yaml
@@ -4,7 +4,7 @@
 type: object
 properties: 
 
-  real_precission:
+  real_precision:
     type: integer
     default: 17
     description: |
diff --git a/doc/openapi/components/schemas/config/hook_obj.yaml b/doc/openapi/components/schemas/config/hook_obj.yaml
index 7d4fa5efc..4adb351a8 100644
--- a/doc/openapi/components/schemas/config/hook_obj.yaml
+++ b/doc/openapi/components/schemas/config/hook_obj.yaml
@@ -30,6 +30,7 @@ discriminator:
     print: hooks/_print.yaml
     restart: hooks/_restart.yaml
     rms: hooks/_rms.yaml
+    round: hooks/_round.yaml
     scale: hooks/_scale.yaml
     shift_seq: hooks/_shift_seq.yaml
     shift_ts: hooks/_shift_ts.yaml
diff --git a/doc/openapi/components/schemas/config/hook_spec.yaml b/doc/openapi/components/schemas/config/hook_spec.yaml
index a9a00d1e0..0f6f4774f 100644
--- a/doc/openapi/components/schemas/config/hook_spec.yaml
+++ b/doc/openapi/components/schemas/config/hook_spec.yaml
@@ -25,6 +25,7 @@ oneOf:
   - print
   - restart
   - rms
+  - round
   - scale
   - shift_seq
   - shift_ts
diff --git a/etc/examples/hooks/pmu_dft.conf b/etc/examples/hooks/pmu_dft.conf
index b28fb0cb1..f30a581f6 100644
--- a/etc/examples/hooks/pmu_dft.conf
+++ b/etc/examples/hooks/pmu_dft.conf
@@ -13,19 +13,18 @@ paths = (
 					"sine"
 				)
 
-				sample_rate = 100,			# sample rate of the input signal
-				dft_rate = 10,				# how often is the DFT beeing calculated?
+				sample_rate = 1000,			# sample rate of the input signal
+				dft_rate = 10,				# number of phasors calculated per second
 
-				start_freqency = 47.7,			# lowest freqyency bin
-				end_freqency = 52.5,			# highst freqyency bin
-				frequency_resolution = 0.01,		# freqyency bin resolution
+				start_freqency = 49.7,			# lowest freqyency bin
+				end_freqency = 50.3,			# highst freqyency bin
+				frequency_resolution = 0.1,		# freqyency bin resolution
 
-				window_size_factor = 1,
+				window_size_factor = 1,			# a factor with which the window will be increased
 				window_type = "hamming",		# one of: flattop, hamming, hann
-				padding_type = "zero" 			# one of: signal_repeat, zero
+				padding_type = "zero", 			# one of: signal_repeat, zero
 				ffrequency_estimate_type = "quadratic", # one of: quadratic
 
-				sync = true,
 				pps_index = 0,				# signal index of the PPS signal
 				
 				angle_unit = "rad" 			# one of: rad, degree
diff --git a/lib/hooks/round.cpp b/lib/hooks/round.cpp
index 304910a91..b84e11649 100644
--- a/lib/hooks/round.cpp
+++ b/lib/hooks/round.cpp
@@ -1,4 +1,4 @@
-/** Scale hook.
+/** Round hook.
  *
  * @author Manuel Pitz <manuel.pitz@eonerc.rwth-aachen.de>
  * @copyright 2014-2022, Institute for Automation of Complex Power Systems, EONERC