Improve

.dvc/.gitignore

@@ -1,3 +1,8 @@
-/config.local
-/tmp
-/cache
+# config.local file path
+config_local_path = '/config.local'
+
+# Temporary files directory
+tmp_path = '/tmp'
+
+# Cache directory
+cache_path = '/cache'

.dvcignore

@@ -1,3 +1,22 @@
-# Add patterns of files dvc should ignore, which could improve
-# the performance. Learn more at
-# https://dvc.org/doc/user-guide/dvcignore
+# This code snippet adds patterns of files that DVC should ignore,
+# which can help improve the performance of DVC operations.
+# 
+# By ignoring certain files or directories, DVC can avoid unnecessary
+# data transfers, file checks, and other operations that can slow down
+# the overall performance of DVC.
+# 
+# The specific pattern used in this code is a URL pointing to the
+# DVC ignore documentation, which provides more information on how
+# to create and use ignore patterns with DVC.
+# 
+# To use this code, simply replace the URL with the desired ignore
+# pattern or patterns, separated by newline characters.
+# 
+# For example, to ignore all files with the extension '.txt' and
+# the 'temp' directory, the code would look like this:
+# 
+#     .txt
+#     temp/
+# 
+# By adding these ignore patterns, DVC will skip any files or
+# directories that match these patterns during its operations.

.gitignore

@@ -6,46 +6,33 @@
 # Reference: https://intellij-support.jetbrains.com/hc/en-us/articles/206544839
 
 # User-specific stuff
-.idea/**/workspace.xml
-.idea/**/tasks.xml
-.idea/**/usage.statistics.xml
-.idea/**/dictionaries
-.idea/**/shelf
+.idea/workspace.xml
+.idea/tasks.xml
+.idea/usage.statistics.xml
+.idea/dictionaries
+.idea/shelf
 
 # Generated files
-.idea/**/contentModel.xml
+.idea/contentModel.xml
 
 # Sensitive or high-churn files
-.idea/**/dataSources/
-.idea/**/dataSources.ids
-.idea/**/dataSources.local.xml
-.idea/**/sqlDataSources.xml
-.idea/**/dynamic.xml
-.idea/**/uiDesigner.xml
-.idea/**/dbnavigator.xml
+.idea/dataSources/
+.idea/dataSources.ids
+.idea/dataSources.local.xml
+.idea/sqlDataSources.xml
+.idea/dynamic.xml
+.idea/uiDesigner.xml
+.idea/dbnavigator.xml
 
 # Gradle
-.idea/**/gradle.xml
-.idea/**/libraries
-
-# Gradle and Maven with auto-import
-# When using Gradle or Maven with auto-import, you should exclude module files,
-# since they will be recreated, and may cause churn.  Uncomment if using
-# auto-import.
-# .idea/artifacts
-# .idea/compiler.xml
-# .idea/jarRepositories.xml
-# .idea/modules.xml
-# .idea/*.iml
-# .idea/modules
-# *.iml
-# *.ipr
+.idea/gradle.xml
+.idea/libraries
 
 # CMake
 cmake-build-*/
 
 # Mongo Explorer plugin
-.idea/**/mongoSettings.xml
+.idea/mongoSettings.xml
 
 # File-based project format
 *.iws
@@ -79,54 +66,31 @@ fabric.properties
 # See https://github.com/joeblau/gitignore.io/issues/186 and https://github.com/joeblau/gitignore.io/issues/360
 
 .idea/
-
-# Reason: https://github.com/joeblau/gitignore.io/issues/186#issuecomment-249601023
-
 *.iml
-modules.xml
-.idea/misc.xml
-*.ipr
 
 # Sonarlint plugin
 .idea/sonarlint
 
 ### Linux ###
 *~
-
-# temporary files which can be created if a process still has a handle open of a deleted file
 .fuse_hidden*
-
-# KDE directory preferences
 .directory
-
-# Linux trash folder which might appear on any partition or disk
 .Trash-*
-
-# .nfs files are created when an open file is removed but is still being accessed
 .nfs*
 
 ### macOS ###
-# General
 .DS_Store
 .AppleDouble
 .LSOverride
-
-# Icon must end with two \r
 Icon
-
-# Thumbnails
 ._*
-
-# Files that might appear in the root of a volume
 .DocumentRevisions-V100
 .fseventsd
 .Spotlight-V100
 .TemporaryItems
 .Trashes
 .VolumeIcon.icns
 .com.apple.timemachine.donotpresent
-
-# Directories potentially created on remote AFP share
 .AppleDB
 .AppleDesktop
 Network Trash Folder
@@ -149,7 +113,6 @@ develop-eggs/
 dist/
 downloads/
 eggs/
-.eggs/
 lib/
 lib64/
 parts/
@@ -164,8 +127,6 @@ share/python-wheels/
 MANIFEST
 
 # PyInstaller
-#  Usually these files are written by a python script from a template
-#  before PyInstaller builds the exe, so as to inject date/other infos into it.
 *.manifest
 *.spec
 
@@ -220,11 +181,7 @@ profile_default/
 ipython_config.py
 
 # pipenv
-#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
-#   However, in case of collaboration, if having platform-specific dependencies or dependencies
-#   having no cross-platform support, pipenv may install dependencies that don't work, or not
-#   install all needed dependencies.
-#Pipfile.lock
+Pipfile.lock
 
 # PEP 582; used by e.g. github.com/David-OConnor/pyflow
 __pypackages__/
@@ -274,7 +231,7 @@ dmypy.json
 ### Vim ###
 # Swap
 [._]*.s[a-v][a-z]
-!*.svg  # comment out if you don't need vector files
+!*.svg
 [._]*.sw[a-p]
 [._]s[a-rt-v][a-z]
 [._]ss[a-gi-z]
@@ -305,29 +262,18 @@ tags
 .ionide
 
 ### Windows ###
-# Windows thumbnail cache files
 Thumbs.db
 Thumbs.db:encryptable
 ehthumbs.db
 ehthumbs_vista.db
-
-# Dump file
 *.stackdump
-
-# Folder config file
 [Dd]esktop.ini
-
-# Recycle Bin used on file shares
 $RECYCLE.BIN/
-
-# Windows Installer files
 *.cab
 *.msi
 *.msix
 *.msm
 *.msp
-
-# Windows shortcuts
 *.lnk
 
 ### Xcode ###

MANIFEST.in

@@ -1,9 +1,11 @@
+# Include all text and markdown files, as well as the LICENSE and VERSION files
 include *.txt
 include *.md
 include LICENSE
 include VERSION
 
+# Exclude specific files and directories
 exclude .gitignore
 exclude .releaserc.json
 exclude .dvcignore
-exclude .dvc
+exclude .dvc/

Makefile

@@ -1,37 +1,35 @@
-PYTHON = python3
-PIP = pip3
-
-.PHONY: help lint test package clean install
-
-help:	# The following lines will print the available commands when entering just 'make'
-ifeq ($(UNAME), Linux)
+# The help target displays a list of available commands when the user enters 'make'
+help:	# Print available commands
 	@grep -P '^[a-zA-Z_-]+:.*?## .*$$' $(MAKEFILE_LIST) | sort | \
 		awk 'BEGIN {FS = ":.*?## "}; {printf "\033[36m%-20s\033[0m %s\n", $$1, $$2}'
-else
-	@awk -F ':.*###' '$$0 ~ FS {printf "%15s%s\n", $$1 ":", $$2}' \
-		$(MAKEFILE_LIST) | grep -v '@awk' | sort
-endif
 
+# The lint target checks the project for linting errors
 lint: ### Validates project with linting rules
 	$(PIP) install pylint
 	$(PYTHON) -m pylint src/
 
+# The test target runs all the project tests
 test: ### Runs all the project tests
 	"Run tests"
 	$(PIP) install pytest
 	$(PYTHON) -m pytest tests/
 
+# The package target creates a source distribution and wheel distribution of the project
 package: clean ### Runs the project setup
 	echo "$(version)" > VERSION
 	$(PYTHON) setup.py sdist bdist_wheel
 
+# The clean target removes any build binaries
 clean: ### Removes build binaries
 	rm -rf build dist
 
+# The install target installs the project from the source distribution
 install: ### Installs required dependencies
 	$(PIP) install dist/ydata-synthetic-$(version).tar.gz
 
+# The publish-docs target publishes the project documentation
 publish-docs: ### Publishes the documentation
 	echo "$(version)" > VERSION
 	$(PIP) install .
 	mike deploy --push --update-aliases $(version) latest
+

docs/stylesheets/extra.css

@@ -1,21 +1,27 @@
+/* Sets the style for annotation index numbers, displaying their corresponding data-md-annotation-id attribute */
 .md-typeset .md-annotation__index > ::before {
     content: attr(data-md-annotation-id);
 }
+
+/* Removes any transformations applied to the annotation index numbers when the element is focused */
 .md-typeset :focus-within > .md-annotation__index > ::before {
     transform: none;
 }
 
+/* Sets the primary color for the content area */
 .md-content {
   --md-typeset-a-color: #002b9e;
 }
 
+/* Applies specific styles when the .md-button--ydata class is used */
 @media {
   .md-button--ydata {
       --md-primary-fg-color: #E32212;
       --md-primary-bg-color: #E32212;
   }
 }
 
+/* Sets the default color shades for the primary and accent colors, as well as code blocks, footer, and YouTube elements */
 :root {
     /* Primary color shades */
     --md-primary-fg-color: #040404;
@@ -32,19 +38,21 @@
     --md-accent-bg-color--light: hsla(0, 0%, 100%, 0.7);
   }
 
+  /* Applies specific styles for code blocks */
   :root > * {
     /* Code block color shades */
     --md-code-bg-color: hsla(0, 0%, 96%, 1);
     --md-code-fg-color: hsla(200, 18%, 26%, 1);
 
-    /* Footer */
+    /* Footer styles */
     --md-footer-bg-color: #040404;
     --md-footer-bg-color--dark: hsla(0, 0%, 0%, 0.32);
     --md-footer-fg-color: hsla(0, 0%, 100%, 1);
     --md-footer-fg-color--light: hsla(0, 0%, 100%, 0.7);
     --md-footer-fg-color--lighter: hsla(0, 0%, 100%, 0.3);
   }
 
+/* Sets the color for YouTube elements */
 .youtube {
   color: #EE0F0F;
 }