Dealing with specs

Hello everyone!

So, as I said before, I got accepted to Outreachy and my whole task during my internship  is to work for OpenStack on python-zaqarclient adding support for Zaqar API v1.1. This week, I had to work on a specification that explained what features are missing in the client side of Zaqar, and which are the things that need to be done in order to add those features.

The thing about specs is that they have to be written with the markup language, which is a system for annotating a document in a way that is syntactically distinguishable from the text. Python uses a type of markup language for documentation, called reStructuredText, which is a component of Docutils.

When writing a spec you have to be very careful to the syntax, because writing something syntactically wrong, changes completely the output, and you’ll have to fix it in order to see your spec like it should be seen. Here’s a link to the reStructuredText, if you want to know more about it: http://docutils.sourceforge.net/docs/user/rst/quickref.html.

Anyway, working on specs was my first weakly internship experience, and I found out that you need to be very precise and be careful to the way you write them, but people is always open to help you understand what is wrong or what you could improve. It was also great to know that my mentor was always available and ready to help me if I had any kind of question.

So, that’s it! Be ready for my next posts because they’ll become more interesting every week!

Advertisements

Leave a Reply

Fill in your details below or click an icon to log in:

WordPress.com Logo

You are commenting using your WordPress.com account. Log Out / Change )

Twitter picture

You are commenting using your Twitter account. Log Out / Change )

Facebook photo

You are commenting using your Facebook account. Log Out / Change )

Google+ photo

You are commenting using your Google+ account. Log Out / Change )

Connecting to %s