# Do's and Don'ts when developing First Project with Ignition?

**URL:** <https://forum.inductiveautomation.com/t/dos-and-donts-when-developing-first-project-with-ignition/93592>\
**Category:** General Discussion\
**Created:** [July 23, 2024, 8:55am UTC](https://forum.inductiveautomation.com/t/dos-and-donts-when-developing-first-project-with-ignition/93592 "2024-07-23T08:55:09Z")\
**Posts on this page:** 1\
**Showing post:** 35

<div class="post-metadata">

**Author:** ![danielps1818](https://avatars.discourse-cdn.com/v4/letter/d/ecae2f/32.png) [@danielps1818](https://forum.inductiveautomation.com/u/danielps1818)\
**Post date:** [September 24, 2024, 11:52am UTC](https://forum.inductiveautomation.com/t/dos-and-donts-when-developing-first-project-with-ignition/93592/35 "2024-09-24T11:52:02Z")

</div>

Adding to what you said @Julian_Islic .

I normally do this good practice:

```python
def func1(parms):
	"""Helpful descriptions to help others understand your code.
	Note: will show up in autofill details, so keep it concise.

	Args:
		parms (dict): Small note explaining the param if necessary.

	Returns:
		tuple: Small explanations of the return
		
     """
     return parms

```

And will show something like this when previewed:  
 ![image](https://us1.discourse-cdn.com/inductiveautomation/original/3X/9/e/9ea9c8096d370222ce97728211ba026c56db5706.png)

You could have multiple parameters listed there with the corresponding type and description. I belive the available types are `int`, `float`, `bool`, `str`, `tuple`, `list`, `dict` and `any`.

Also I think it's possible to only show the type without the description, but I wasn't able to do it.

![image](https://us1.discourse-cdn.com/inductiveautomation/original/3X/3/9/393344ca11531d1fd49a3ca31c777cbb7d686780.png)

Make sure to make short and specifics descriptions. This is not the place to explain in detail how the functions works.

---

_[View the full topic](https://forum.inductiveautomation.com/t/dos-and-donts-when-developing-first-project-with-ignition/93592)._