Starting FIrst Week

I will be joining officially from tomorrow (29th May). 

1) Current implementation of meta (with additions I made) works on records, modules, interfaces, function like objects(functions, transform, embed, module with params).
2) Type information is generated using getFriendlyTypeStr for the time being. As gavin replied, we would need to replace that more informative system.
3) Module Inheritance works by including all inherited attributes in child module automatically. If inherited attribute is overriden, new position info is generated otherwise position info in parent in maintained.
4) Record Inheritance works similarly by including all inherited fields in new child record.

Currently, I am using ECLIR as a template to understand how the expression tree is to be navigated and how to access various information regarding objects in an ecl file since ECLIR provides a lot of similar info that we need for meta, albeit in a different format.

In first week, I will work on following :
1) Test current meta implementation against a number of cases to determine what is working correctly and what is not. This is variations in objects and structure of the ecl file.
2) Check up on inheritance problem by determining which attributes are overriden. Also determine the linkage info to parent module.
3) Start working on ideas for new type info system.

Comments

Post a Comment

Popular posts from this blog

Fifth Week

In fifth week, we achieved following goals : Text Documentation was generated. XML Doc was read to get appropriate information for Text Documentation. Jinja2 library was used to generate Template. For Text Documentation, we limited all information display to 150 chars per line. The Definition was indented on basis of their level in the tree. We use textwrap library to heuristically break long sentences along word boundaries. Each folder was also given a pkg.toc.txt file, which contained bundle information and links to all files in that folder. Heuristic signature breaking was designed. The signature for definition was read and broken into return type, name and parameter string. The breaking occured along heuristic : break at first incidence of name in the sign that it not enclosed by brackets and ends in whitespace or '('. Then break at end of the name.
Read more

Eighth Week

In eighth week, we achieved following goals: Generate Links to any external Documentation for given ecl source tree. For example , if project A has IMPORT B.B1; stmt in some file and we have included path to B Code in eclcc using -I option, that we can also include path to documentation of B which will be linked correctly to any such import stmts in documentation of A. To generate external documentation, each ecldoc run generates a tree.json file for each folder in given ecl source tree. Tree.json files provides paths to each file starting from the folder the json file is in. If the corresponding source path is included in eclcc, we can determine target path using this json file. Example - If input_root below is included in -I option of eclcc, then any imports of keys in tree (example_8, intest, intest.example_11, intest.inintest, intest.inintest.example_2) will be linked correctly to documentation in output_root in each format. { "input_root": "/media/sart
Read more

Ninth Week

In ninth week, we achieved following goals : Generates Documentation for Users in clienttools documentation format. Code Refactoring : Here we reworked the code, so that all output formats are present in separate directories. This will allow easier extension to other formats in future. The only file needed to be modified to add more formats is Formats/generators.py and it will be added to ecldoc. Templates were moved to separate directory which makes it easier to install using setuptools in python. Code was reworked to generate absolute imports rather than relative imports. This makes it easier to move the destination of imports. Code was documented using docstrings and comments wherever required. Technical Documentation was generated to inform overall working of ecldoc code for future.
Read more