search

funderburkjim / Markup-Sanskrit-Names-of-Plants

Proposal for Project for one of Pawan Goyal's students
Other
0 stars 0 forks source link

Correct snp01.txt to use XML markup conventions #8

Open funderburkjim opened 9 years ago

funderburkjim commented 9 years ago

@beenooyadav @shubham3796

There is one small detail you need to change in snp01.py. Here is line 86 of snp01.txt:

<>b) the seed of {%rudra1ks2a%} (<c>MW<\c>; <c>PW<\c>

Here is how it should look:

<>b) the seed of {%rudra1ks2a%} (<c>MW</c>; <c>PW</c>

Change snp01.py so it uses </c> for the 'closing tag'.

The reason for the change is to have consistency with XML markup conventions.

The w3schools website gives a good short introduction to XML here.

Now it is true that snp.txt itself does NOT conform to the standards of XML markup. So, it is not exactly wrong that your closing 'c' tag does not follow the XML conventions for a closing tag (namely, use forward-slash, not back-slash). However, at some point snpxx.txt will get converted to snp.xml (a markup of snpxx.txt that DOES following XML markup conventions). And it will make life simpler if our 'c' tag is used according to XML standards.

Once you've done that and remade snp01.txt, we can consider this first program snp01.py as finished.

funderburkjim commented 9 years ago

Here's one other thing you should do in your modified snp01.py: WRITE COMMENTS

Even though this program is a small program, it is somewhat tricky. It will be much easier for someone, even you, to understand this program if it is well-commented.

gasyoun commented 9 years ago

Otherwise after half a year even the author will forget what it was.

funderburkjim commented 9 years ago

@beenooyadav @shubham3796
Are you having a problem with this step and the next?

gasyoun commented 9 years ago

Github is for submitting updates on an everyday basis. If there are none - there must be issues.