From 00cc534ec51da9eb13e468508ab8e81f0628288c Mon Sep 17 00:00:00 2001 From: mir-am Date: Thu, 4 Mar 2021 14:58:31 +0100 Subject: [PATCH] Revise README and CHANGELOG files --- CHANGELOG.md | 17 ++++++++--------- README.md | 4 ++-- 2 files changed, 10 insertions(+), 11 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 38608ac..a8f4124 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -3,7 +3,7 @@ All notable changes to the [LibSA4Py](https://github.com/saltudelft/libsa4py) to ## [Unreleased] -## [0.1.0] - 2021-03-03 +## [0.1.0] - 2021-03-04 ### Added #### Pipeline @@ -16,7 +16,7 @@ All notable changes to the [LibSA4Py](https://github.com/saltudelft/libsa4py) to - Throwing `NullProjectException` for projects that have no source code files. #### AST-based Extractor -- Creating a normalized Seq2Seq representation of a source code file aligned with a sequence types of identifiers. +- Creating a normalized Seq2Seq representation of a source code file aligned with a sequence of identifiers' type. - Extracting import names of a module. - Extracting the name of global variables in a module with their type annotations (if present). - Calculating type annotation coverage for the whole project and its source code files. @@ -25,22 +25,21 @@ All notable changes to the [LibSA4Py](https://github.com/saltudelft/libsa4py) to - Extracting the name of functions in a module or in a class. - Extracting the name of functions' parameters and their type annotations (if present). - Extracting return expressions in functions. -- Extracting the occurrence of a function's parameters in in the function's body. +- Extracting the occurrence of a function's parameters in the function's body. - Extracting the return type of functions (if present). - Extracting docstring for functions' parameters and their return type. -- Extracting short and long description of functions in their docstring. +- Extracting short and long descriptions of functions in their docstring. #### AST-based Transformers -- Adding space to around source code tokens for better tokenization. +- Adding space around source code tokens for better tokenization. - Removing comment and docstring from source code for its normalized Seq2Seq representation. - Removing string literals from source code for its normalized Seq2Seq representation. - Removing numeric literals from source code for its normalized Seq2Seq representation. - Removing type annotations from source code for its normalized Seq2Seq representation. -- Propagating the type of functions' parameters in the function body and module-level constants - +- Propagating the type of functions' parameters in the function body and module-level constants. ### Fixed -- A special case where an uninitialized variables with types caused exceptions. +- A special case where uninitialized variables with types caused exceptions. - A case where variables in a tuple couldn't be extracted in multiple assignments. - Handling nested tuples in multiple assignments for extracting var names. -- A case where a type-annotated class attribute is not initialized for removing its type \ No newline at end of file +- A case where a type-annotated class attribute is not initialized for removing its type. \ No newline at end of file diff --git a/README.md b/README.md index 61fde71..3e3d782 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,5 @@ -# LibSA4Py -It is a static analysis library for Python, which extracts type hints and features for training ML-based type inference models. +# Intro +`LibSA4Py` is a static analysis library for Python, which extracts type hints and features for training ML-based type inference models. - [Requirements](#requirements) - [Quick Installation](#quick-installation)