docsrc: Update required python version in docs

[Serial-ATA]

After some testing, it looks like the oldest python version XED/mbuild supports is 3.6.

[marjevan]

Thanks. We're currently working on an update for XED documentation.
I'll make sure this will be updated as well.

(BTW, the minimal required Python version is 3.7)

[Serial-ATA]

(BTW, the minimal required Python version is 3.7)

Ah, should I update the PR, or are you just going to update your local doc changes?

Also, I'm interested in refactoring the Python code with better doc comments, type annotations, and more descriptive variable names. Would you guys be interested in such contributions?

I've been trying to better understand the format of the data files, and since #39 is still WIP, I resorted to trying to read the source code here, and it's pretty difficult (since the things I listed above are pretty lackluster at the moment).

[marjevan]

Ah, should I update the PR, or are you just going to update your local doc changes?

There's no need to update this PR. I'll update it internally and publish it with the next XED external release.

Also, I'm interested in refactoring the Python code with better doc comments, type annotations, and more descriptive variable names. Would you guys be interested in such contributions?

It can be helpful, especially type annotations. We're constantly updating it, but it is really a step-by-step and incremental progress.
Sure, you're welcome to contribute. There's an option where we'll modify things to match the project standards, but a starting point can help us with a shorter shipping time.
Please follow the XED contributing guide: CONTRIBUTING.md

I've been trying to better understand the format of the data files, and since #39 is still WIP, I resorted to trying to read the source code here, and it's pretty difficult (since the things I listed above are pretty lackluster at the moment).

As far as I see, #42 adds a description for most of the datafiles topics. I wonder if I should close #39 ...
Let me know if there's anything else missing.

[Serial-ATA]

As far as I see, #42 adds a description for most of the datafiles topics. I wonder if I should close #39 ...
Let me know if there's anything else missing.

#42 is definitely a start, but as mentioned in #39 (comment), it is only really a start.

Currently, there are only short descriptions of files in engineering-notes.txt. The file could really use:

• Some example syntax with an explanation of what it means. That'd help clear up confusion like Question: What is the meaning of the datafile OPERANDS content in xed? #266 and Question: What is the meaning of the datafiles PATTERN content? #267
• An exhaustive list of instruction tokens. Currently, only "The most common tokens" are listed.
• The encode/decode patterns could definitely use more documentation. For example, the only file that explains the meaning of {@, *, nothing, error} is https://github.com/intelxed/xed/blob/main/datafiles/xed-modrm-encode.txt, but these values are used in other files. Another thing is SEQUENCEs, which don't seem to have any documentation?

[marjevan]

#42 is definitely a start, but as mentioned in [#39 (comment)]

I see.
We're currently swamped with a lot of tasks, but we'll do our best to help you out as soon as we can.
Thanks for your patience and understanding!

[Serial-ATA]

Oh yeah, take as much time as you need. Sorry if I made this seem like an immediately issue. 😄

I'll start adding types to the Python source, which I feel will help a lot where the documentation is lacking.